From baecd6f6c9095f98e72d50ab65f1fc3995c011c6 Mon Sep 17 00:00:00 2001 From: a2a-platform Date: Sat, 27 Jun 2026 01:04:02 +0000 Subject: [PATCH] deploy --- README.md | 11 + a2a.yaml | 13 + agent.py | 434 + openapi.json | 292861 ++++++++++++++++++++++++++++++ requirements.txt | 7 + skills/account/SKILL.md | 64 + skills/addresses/SKILL.md | 30 + skills/batches/SKILL.md | 117 + skills/carriers/SKILL.md | 76 + skills/connections/SKILL.md | 70 + skills/documents/SKILL.md | 22 + skills/downloads/SKILL.md | 27 + skills/environment/SKILL.md | 57 + skills/insurance/SKILL.md | 29 + skills/labels/SKILL.md | 132 + skills/manifests/SKILL.md | 57 + skills/packages/SKILL.md | 57 + skills/pickups/SKILL.md | 54 + skills/rates/SKILL.md | 47 + skills/service-points/SKILL.md | 33 + skills/shipments/SKILL.md | 134 + skills/tags/SKILL.md | 57 + skills/tokens/SKILL.md | 23 + skills/tracking/SKILL.md | 47 + skills/warehouses/SKILL.md | 67 + 25 files changed, 294526 insertions(+) create mode 100644 README.md create mode 100644 a2a.yaml create mode 100644 agent.py create mode 100644 openapi.json create mode 100644 requirements.txt create mode 100644 skills/account/SKILL.md create mode 100644 skills/addresses/SKILL.md create mode 100644 skills/batches/SKILL.md create mode 100644 skills/carriers/SKILL.md create mode 100644 skills/connections/SKILL.md create mode 100644 skills/documents/SKILL.md create mode 100644 skills/downloads/SKILL.md create mode 100644 skills/environment/SKILL.md create mode 100644 skills/insurance/SKILL.md create mode 100644 skills/labels/SKILL.md create mode 100644 skills/manifests/SKILL.md create mode 100644 skills/packages/SKILL.md create mode 100644 skills/pickups/SKILL.md create mode 100644 skills/rates/SKILL.md create mode 100644 skills/service-points/SKILL.md create mode 100644 skills/shipments/SKILL.md create mode 100644 skills/tags/SKILL.md create mode 100644 skills/tokens/SKILL.md create mode 100644 skills/tracking/SKILL.md create mode 100644 skills/warehouses/SKILL.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f84ad94 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# shipengine-openapi-agent + +Generated A2APack agent for ShipEngine API. + +- Source OpenAPI: https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.json +- Generated operations: 97 +- Main skill: `auto` +- Routing mode: DeepAgents subagents across 20 route groups + +The generated code is intentionally editable. Tune prompts, operation +grouping, auth names, and safety policy before publishing serious agents. diff --git a/a2a.yaml b/a2a.yaml new file mode 100644 index 0000000..8583b87 --- /dev/null +++ b/a2a.yaml @@ -0,0 +1,13 @@ +name: shipengine-openapi-agent +version: 1.1.202604070904 +entrypoint: agent:ShipengineOpenapiAgent +description: Shipping and logistics API for labels, rates, tracking, address validation, + and carrier integrations. +runtime: + resources: + cpu: 200m + memory: 512Mi + egress: + allow_hosts: + - api.shipengine.com + deny_internet_by_default: true diff --git a/agent.py b/agent.py new file mode 100644 index 0000000..404c140 --- /dev/null +++ b/agent.py @@ -0,0 +1,434 @@ +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`
`stamps_com`
`ups`
`usps`\\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`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`
`stamps_com`
`ups`
`usps`\\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`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`
`stamps_com`
`ups`
`usps`\\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`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`
`stamps_com`
`ups`
`usps`\\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`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`
`stamps_com`
`ups`
`usps`\\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`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`
`stamps_com`
`ups`
`usps`\\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`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`
`stamps_com`
`ups`
`usps`\\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`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() diff --git a/openapi.json b/openapi.json new file mode 100644 index 0000000..343cc09 --- /dev/null +++ b/openapi.json @@ -0,0 +1,292861 @@ +{ + "components": { + "responses": { + "400_error_response": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404_error_response": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "409_error_response": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request conflicts with an existing resource." + }, + "500_error_response": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "schemas": { + "Allowed incoterms": { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + }, + "account_settings": { + "additionalProperties": false, + "description": "A ShipEngine account settings response body", + "properties": { + "default_label_layout": { + "allOf": [ + { + "description": "The possible default label layout values", + "enum": [ + "4x6", + "Letter" + ], + "title": "default_label_layout", + "type": "string" + } + ] + } + }, + "title": "account_settings", + "type": "object" + }, + "account_settings_images": { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + }, + "add_funds_to_carrier_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "An add funds to carrier request body", + "title": "add_funds_to_carrier_request_body", + "type": "object" + }, + "add_funds_to_carrier_response_body": { + "additionalProperties": false, + "description": "The current balance of the requested carrier account", + "properties": { + "balance": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The current balance of the account", + "readOnly": true + } + }, + "required": [ + "balance" + ], + "title": "add_funds_to_carrier_response_body", + "type": "object" + }, + "add_funds_to_insurance_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "An add funds to insurance request body", + "title": "add_funds_to_insurance_request_body", + "type": "object" + }, + "add_funds_to_insurance_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Add funds to insurance response body", + "title": "add_funds_to_insurance_response_body", + "type": "object" + }, + "add_to_batch_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A modify batch object", + "properties": { + "rate_ids": { + "description": "Array of Rate IDs to be modifed on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Rate ID to be modified on the batch" + }, + "type": "array" + }, + "shipment_ids": { + "description": "The Shipment Ids to be modified on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Shipment ID to be modified on the batch" + }, + "type": "array" + } + }, + "title": "modify_batch", + "type": "object" + } + ], + "description": "An add to batch request body", + "title": "add_to_batch_request_body", + "type": "object" + }, + "address": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + "address_residential_indicator": { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + }, + "address_to_validate": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "description": "Any residential or business mailing address, anywhere in the world.\n", + "required": [ + "address_line1", + "city_locality", + "state_province", + "country_code" + ], + "title": "address_to_validate", + "type": "object" + }, + "address_validating_shipment": { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + }, + "address_validation_code": { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + }, + "address_validation_detail_code": { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + }, + "address_validation_message_type": { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + }, + "address_validation_result": { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + }, + "address_validation_status": { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + }, + "advanced_shipment_options": { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + }, + "alternative_identifier": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "alternative_identifiers": { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + }, + "ancillary_service_endorsement": { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + }, + "batch": { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + }, + "batch_response_error": { + "additionalProperties": false, + "description": "A batch response error", + "properties": { + "error": { + "description": "Error message associated with the shipment.", + "example": "Recipient address has not been verified.", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "An external shipment id associated with the shipment", + "readOnly": true, + "type": "string" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + } + }, + "title": "batch_response_error", + "type": "object" + }, + "batch_status": { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + }, + "batches_sort_by": { + "description": "The possible batches sort by values", + "enum": [ + "ship_date", + "processed_at", + "created_at" + ], + "title": "batches_sort_by", + "type": "string" + }, + "bill_to_party": { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + }, + "bulk_rate": { + "additionalProperties": false, + "description": "A bulk rate", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "An array of errors that were returned while retrieving the bulk rate", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ], + "description": "An error that occurred while retrieving the bulk rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "rate_request_id", + "shipment_id", + "created_at", + "status", + "errors" + ], + "title": "bulk_rate", + "type": "object" + }, + "calculate_rates_request_body": { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "rate_options": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate request body", + "properties": { + "calculate_tax_amount": { + "description": "Calculate the duties and tariffs for cross border shipments.", + "type": "boolean" + }, + "carrier_ids": { + "description": "Array of carrier ids to get rates for", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier ids" + }, + "minItems": 1, + "type": "array" + }, + "is_return": { + "description": "Indicate if it's a return shipment", + "type": "boolean" + }, + "package_types": { + "items": { + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "preferred_currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + }, + "rate_type": { + "description": "Indicates what type of rating to perform", + "enum": [ + "check", + "shipment", + "quick" + ], + "type": "string" + }, + "service_codes": { + "items": { + "description": "Item Service Codes", + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "carrier_ids" + ], + "title": "rate_request_body", + "type": "object" + } + ], + "description": "The rate options" + } + }, + "title": "rate_request_options", + "type": "object" + } + ], + "description": "A rate shipment request body", + "oneOf": [ + { + "properties": { + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment" + } + }, + "title": "shipment_id_request", + "type": "object" + }, + { + "properties": { + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ], + "description": "The shipment object" + } + }, + "title": "rate_shipment_request", + "type": "object" + } + ], + "properties": { + "ship_from_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + }, + "ship_to_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + } + }, + "required": [ + "shipment_id", + "shipment" + ], + "title": "calculate_rates_request_body", + "type": "object" + }, + "calculate_rates_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "rate_response": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rates information resource", + "properties": { + "created_at": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "When the rate was created", + "format": "date-time", + "type": "string" + }, + "errors": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "type": "array" + }, + "invalid_rates": { + "default": [], + "description": "An array of invalid shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "Invalid Shipment Rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "rates": { + "description": "An array of shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + }, + { + "properties": { + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "description": "Shipment Rates", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "title": "rates_information", + "type": "object" + } + ], + "description": "The rates response" + } + }, + "title": "rate_response", + "type": "object" + } + ], + "description": "A rate shipment response body", + "required": [ + "rate_response", + "shipment_id", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "calculate_rates_response_body", + "type": "object" + }, + "cancel_refund_label_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A cancel refund label response body", + "title": "cancel_refund_label_response_body", + "type": "object" + }, + "carrier": { + "additionalProperties": false, + "description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n", + "properties": { + "account_number": { + "description": "The account number that the carrier is connected to.", + "example": "account_570827", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "allows_returns": { + "description": "The carrier has services that support return shipments.", + "readOnly": true, + "type": "boolean" + }, + "balance": { + "description": "Current available balance", + "example": 3799.52, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier.", + "readOnly": true + }, + "connection_status": { + "description": "The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.", + "enum": [ + "pending_approval", + "approved" + ], + "readOnly": true, + "type": "string" + }, + "disabled_by_billing_plan": { + "description": "The carrier is disabled by the current ShipEngine account's billing plan.", + "readOnly": true, + "type": "boolean" + }, + "friendly_name": { + "description": "Screen readable name", + "example": "Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "funding_source_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Funding source ID for the carrier", + "nullable": true, + "readOnly": true + }, + "has_multi_package_supporting_services": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "nickname": { + "description": "Nickname given to the account when initially setting up the carrier.", + "example": "ShipEngine Account - Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "options": { + "description": "A list of options that are available to that carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "packages": { + "description": "A list of package types that are supported by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "primary": { + "description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation", + "readOnly": true, + "type": "boolean" + }, + "requires_funded_amount": { + "description": "Indicates whether the carrier requires funding to use its services", + "readOnly": true, + "type": "boolean" + }, + "send_rates": { + "description": "The carrier provides rates for the shipment.", + "readOnly": true, + "type": "boolean" + }, + "services": { + "description": "A list of services that are offered by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "supports_label_messages": { + "description": "The carrier supports adding custom label messages to an order.", + "readOnly": true, + "type": "boolean" + }, + "supports_user_managed_rates": { + "description": "The carrier supports user-managed rates for shipments.", + "readOnly": true, + "type": "boolean" + } + }, + "title": "carrier", + "type": "object" + }, + "carrier_advanced_option": { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + }, + "carrier_code": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + }, + "carrier_name": { + "description": "The shipping carriers that are supported by ShipEngine", + "enum": [ + "access_worldwide", + "amazon_buy_shipping", + "amazon_shipping_uk", + "apc", + "asendia", + "australia_post", + "canada_post", + "dhl_ecommerce", + "dhl_express", + "dhl_express_au", + "dhl_express_ca", + "dhl_express_uk", + "dpd", + "endicia", + "fedex", + "fedex_uk", + "firstmile", + "imex", + "newgistics", + "ontrac", + "purolator_canada", + "royal_mail", + "rr_donnelley", + "seko", + "sendle", + "stamps_com", + "ups", + "lasership" + ], + "title": "carrier_name", + "type": "string" + }, + "carrier_name_with_settings": { + "description": "The shipping carriers for which ShipEngine supports carrier settings", + "enum": [ + "dhl_express", + "fedex", + "newgistics", + "ups" + ], + "title": "carrier_name_with_settings", + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "collect_on_delivery_payment_type": { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + }, + "compare_bulk_rates_request_body": { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "rate_options": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate request body", + "properties": { + "calculate_tax_amount": { + "description": "Calculate the duties and tariffs for cross border shipments.", + "type": "boolean" + }, + "carrier_ids": { + "description": "Array of carrier ids to get rates for", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier ids" + }, + "minItems": 1, + "type": "array" + }, + "is_return": { + "description": "Indicate if it's a return shipment", + "type": "boolean" + }, + "package_types": { + "items": { + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "preferred_currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + }, + "rate_type": { + "description": "Indicates what type of rating to perform", + "enum": [ + "check", + "shipment", + "quick" + ], + "type": "string" + }, + "service_codes": { + "items": { + "description": "Item Service Codes", + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "carrier_ids" + ], + "title": "rate_request_body", + "type": "object" + } + ], + "description": "The rate options" + } + }, + "title": "rate_request_rate_options", + "type": "object" + } + ], + "description": "A rate shipments request body", + "oneOf": [ + { + "properties": { + "shipment_ids": { + "description": "The array of shipment IDs", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "shipment ids" + }, + "type": "array" + } + }, + "required": [ + "shipment_ids" + ], + "title": "rate_request_by_shipment_ids", + "type": "object" + }, + { + "properties": { + "shipments": { + "description": "The array of shipments to get bulk rate estimates for", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ], + "description": "The shipment to get a bulk rate estimate for" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "shipments" + ], + "title": "rate_request_by_shipments", + "type": "object" + } + ], + "properties": { + "ship_from_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + }, + "ship_to_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + } + }, + "required": [ + "rate_options" + ], + "title": "compare_bulk_rates_request_body", + "type": "object" + }, + "compare_bulk_rates_response_body": { + "description": "A bulk rate response body", + "items": { + "additionalProperties": false, + "description": "A bulk rate", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "An array of errors that were returned while retrieving the bulk rate", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ], + "description": "An error that occurred while retrieving the bulk rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "rate_request_id", + "shipment_id", + "created_at", + "status", + "errors" + ], + "title": "bulk_rate", + "type": "object" + }, + "title": "compare_bulk_rates_response_body", + "type": "array" + }, + "connect_access_worldwide_request_body": { + "additionalProperties": false, + "description": "An Access Worldwide account information request body", + "properties": { + "nickname": { + "description": "The nickname associated with the carrier connection", + "example": "Stamps.com", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Access Worldwide Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Access Worldwide Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_access_worldwide_request_body", + "type": "object" + }, + "connect_amazon_buy_shipping_request_body": { + "additionalProperties": false, + "description": "An Amazon account information request body", + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "merchant_seller_id": { + "minLength": 1, + "type": "string" + }, + "mws_auth_token": { + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname to be associated with the account connection", + "example": "Test Amazon Buy Shipping", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "merchant_seller_id", + "email", + "mws_auth_token" + ], + "title": "connect_amazon_buy_shipping_request_body", + "type": "object" + }, + "connect_amazon_shipping_uk": { + "additionalProperties": false, + "description": "An Amazon Shipping UK account information request body", + "properties": { + "auth_code": { + "description": "Amazon UK Shipping auth code.", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "The nickname associated with the carrier connection", + "example": "Stamps.com", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "auth_code" + ], + "title": "connect_amazon_shipping_uk", + "type": "object" + }, + "connect_apc_request_body": { + "additionalProperties": false, + "description": "An APC account information request body", + "properties": { + "nickname": { + "description": "The nickname for the APC account", + "example": "APC carrier account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The password for the APC account", + "example": 12345, + "minLength": 1, + "type": "string" + }, + "username": { + "description": "The username for the APC account", + "example": "john_doe", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_apc_request_body", + "type": "object" + }, + "connect_asendia_request_body": { + "additionalProperties": false, + "description": "An Asendia account information request body", + "properties": { + "account_number": { + "description": "Asendia account number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "Asendia api_key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "The nickname of the Asendia account", + "example": "Asendia account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Asendia password", + "minLength": 1, + "type": "string" + }, + "processing_location": { + "description": "Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL'", + "minLength": 1, + "type": "string" + }, + "sub_account_number": { + "description": "Asendia sub account number", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Asendia username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "username", + "password", + "api_key", + "processing_location" + ], + "title": "connect_asendia_request_body", + "type": "object" + }, + "connect_australia_post_request_body": { + "additionalProperties": false, + "description": "An Australia Post account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "API key", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "description": "API secret", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "api_key", + "api_secret", + "nickname" + ], + "title": "connect_australia_post_request_body", + "type": "object" + }, + "connect_canada_post_request_body": { + "additionalProperties": false, + "description": "A Canada Post account information request body", + "properties": { + "account_number": { + "description": "Canada Post Account Number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "Canada Post Account API Key", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "description": "Canada Post Account API Secret", + "minLength": 1, + "type": "string" + }, + "contract_id": { + "description": "Canada Post Account Contract ID", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "api_key", + "api_secret", + "account_number", + "contract_id" + ], + "title": "connect_canada_post_request_body", + "type": "object" + }, + "connect_carrier_request_body": { + "oneOf": [ + { + "additionalProperties": false, + "description": "An Access Worldwide account information request body", + "properties": { + "nickname": { + "description": "The nickname associated with the carrier connection", + "example": "Stamps.com", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Access Worldwide Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Access Worldwide Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_access_worldwide_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Amazon account information request body", + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "merchant_seller_id": { + "minLength": 1, + "type": "string" + }, + "mws_auth_token": { + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname to be associated with the account connection", + "example": "Test Amazon Buy Shipping", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "merchant_seller_id", + "email", + "mws_auth_token" + ], + "title": "connect_amazon_buy_shipping_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Amazon Shipping UK account information request body", + "properties": { + "auth_code": { + "description": "Amazon UK Shipping auth code.", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "The nickname associated with the carrier connection", + "example": "Stamps.com", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "auth_code" + ], + "title": "connect_amazon_shipping_uk", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An APC account information request body", + "properties": { + "nickname": { + "description": "The nickname for the APC account", + "example": "APC carrier account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The password for the APC account", + "example": 12345, + "minLength": 1, + "type": "string" + }, + "username": { + "description": "The username for the APC account", + "example": "john_doe", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_apc_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Asendia account information request body", + "properties": { + "account_number": { + "description": "Asendia account number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "Asendia api_key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "The nickname of the Asendia account", + "example": "Asendia account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Asendia password", + "minLength": 1, + "type": "string" + }, + "processing_location": { + "description": "Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL'", + "minLength": 1, + "type": "string" + }, + "sub_account_number": { + "description": "Asendia sub account number", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Asendia username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "username", + "password", + "api_key", + "processing_location" + ], + "title": "connect_asendia_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Australia Post account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "API key", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "description": "API secret", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "api_key", + "api_secret", + "nickname" + ], + "title": "connect_australia_post_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Canada Post account information request body", + "properties": { + "account_number": { + "description": "Canada Post Account Number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "Canada Post Account API Key", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "description": "Canada Post Account API Secret", + "minLength": 1, + "type": "string" + }, + "contract_id": { + "description": "Canada Post Account Contract ID", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "api_key", + "api_secret", + "account_number", + "contract_id" + ], + "title": "connect_canada_post_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Ecommerce account information request body", + "properties": { + "account_number": { + "deprecated": true, + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "ancillary_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "api_key": { + "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", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "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", + "minLength": 1, + "type": "string" + }, + "client_id": { + "description": "The client id", + "minLength": 1, + "type": "string" + }, + "distribution_center": { + "description": "The distribution center", + "minLength": 1, + "type": "string" + }, + "ftp_password": { + "deprecated": true, + "description": "FTP password", + "minLength": 1, + "type": "string" + }, + "ftp_username": { + "deprecated": true, + "description": "FTP username", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "A nickname to help you identify this account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The account password", + "minLength": 1, + "type": "string" + }, + "pickup_number": { + "description": "The pickup number", + "minLength": 1, + "type": "string" + }, + "registration_id": { + "type": "string" + }, + "software_name": { + "type": "string" + }, + "sold_to": { + "description": "Sold To field", + "type": "string" + }, + "username": { + "description": "The account username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "client_id", + "username", + "password", + "pickup_number", + "distribution_center" + ], + "title": "connect_dhl_ecommerce_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL express account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Required if site id is provided", + "minLength": 1, + "type": "string" + }, + "site_id": { + "description": "Required if password is provided", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Express AU account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_au_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Express CA account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_ca_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Express UK account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "site_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the site" + } + }, + "required": [ + "account_number", + "site_id", + "password", + "nickname" + ], + "title": "connect_dhl_express_uk_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DPD account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "password", + "nickname" + ], + "title": "connect_dpd_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Endicia account information request body", + "properties": { + "account": { + "description": "Account", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "passphrase": { + "description": "Passphrase", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account", + "passphrase" + ], + "title": "connect_endicia_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Fedex account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "address1": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "address2": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "agree_to_eula": { + "description": "Boolean signaling agreement to the Fedex End User License Agreement", + "type": "boolean" + }, + "city": { + "description": "The city", + "minLength": 1, + "type": "string" + }, + "company": { + "description": "The company", + "minLength": 1, + "type": "string" + }, + "country_code": { + "description": "Country code", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "first_name": { + "description": "First name", + "minLength": 1, + "type": "string" + }, + "last_name": { + "description": "Last name", + "minLength": 1, + "type": "string" + }, + "meter_number": { + "description": "Meter number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal Code", + "minLength": 1, + "type": "string" + }, + "state": { + "description": "State", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "address1", + "city", + "country_code", + "email", + "first_name", + "last_name", + "phone", + "postal_code", + "state", + "nickname", + "agree_to_eula" + ], + "title": "connect_fedex_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Fedex UK account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "address1": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "address2": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "agree_to_eula": { + "description": "Boolean signaling agreement to the Fedex End User License Agreement", + "type": "boolean" + }, + "city": { + "description": "The city", + "minLength": 1, + "type": "string" + }, + "company": { + "description": "The company", + "minLength": 1, + "type": "string" + }, + "country_code": { + "description": "Country code", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "first_name": { + "description": "First name", + "minLength": 1, + "type": "string" + }, + "last_name": { + "description": "Last name", + "minLength": 1, + "type": "string" + }, + "meter_number": { + "description": "Meter number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal Code", + "minLength": 1, + "type": "string" + }, + "state": { + "description": "State", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "address1", + "city", + "country_code", + "email", + "first_name", + "last_name", + "phone", + "postal_code", + "state", + "nickname", + "agree_to_eula" + ], + "title": "connect_fedex_uk_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A First Mile account information request body", + "properties": { + "mailer_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the mailer" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "profile_name": { + "description": "Profile name", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "mailer_id", + "password" + ], + "title": "connect_firstmile_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Imex account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_imex_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Lasership account information request body", + "properties": { + "Address": { + "description": "Address", + "type": "string," + }, + "Address2": { + "description": "Address2", + "type": "string," + }, + "AttrAlcohol": { + "description": "Set this to true if your shipments will always contain Alcohol", + "type": "boolean," + }, + "AttrControlledSubstance": { + "description": "Set this to true if your shipments will always contain Controlled Substances", + "type": "boolean," + }, + "AttrDryIce": { + "description": "Set this to true if your shipments will always contain DryIce", + "type": "boolean," + }, + "AttrExplosive": { + "description": "Set this to true if your shipments will always contain Explosives", + "type": "boolean," + }, + "AttrHazmat": { + "description": "Set this to true if your shipments will always contain Hazmat", + "type": "boolean," + }, + "AttrNoRTS": { + "description": "Set this to true if your shipments will always use \"No Return To Sender\"", + "type": "boolean," + }, + "AttrPerishable": { + "description": "Set this to true if your shipments will always be Perishable", + "type": "boolean," + }, + "AttrRefrigerated": { + "description": "Set this to true if your shipments will always require Refrigeration", + "type": "boolean," + }, + "AttrTwoPersons": { + "description": "Set this to true if your shipments will always require Two Persons", + "type": "boolean," + }, + "City": { + "description": "City", + "type": "string," + }, + "Email": { + "description": "Email", + "type": "string," + }, + "Phone": { + "description": "Phone", + "type": "string," + }, + "PostalCode": { + "description": "PostalCode", + "type": "string," + }, + "State": { + "description": "State", + "type": "string," + }, + "country": { + "description": "Country", + "type": "string," + }, + "customer_branch": { + "description": "Customer Branch", + "minLength": 1, + "type": "string" + }, + "declare_piece_attributes_separately_for_every_shipment": { + "default": false, + "description": "Declare piece attributes separately for every shipment, overrides individual attribute below.", + "type": "boolean," + }, + "facility_code": { + "description": "Facility Code", + "type": "string," + }, + "instructions": { + "description": "Instructions", + "type": "string," + }, + "lasership_critical_entry_time": { + "description": "Critical Entry Time (local time)", + "type": "string," + }, + "lasership_critical_pull_time": { + "description": "Critical Pull Time (local time)", + "type": "string," + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "web_services_id": { + "description": "Web Service ID (WSID)", + "minLength": 1, + "type": "string" + }, + "web_services_key": { + "description": "Web Service Key (WSKey)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "web_services_id", + "web_services_key", + "customer_branch", + "Address", + "PostalCode", + "City", + "State", + "lasership_critical_pull_time", + "lasership_critical_entry_time" + ], + "title": "connect_lasership_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Newgistics account information request body", + "properties": { + "induction_site": { + "description": "Induction site", + "minLength": 1, + "type": "string" + }, + "mailer_id": { + "description": "Mailer id", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "merchant_id": { + "description": "Merchant id", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "induction_site", + "nickname" + ], + "title": "connect_newgistics_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Ontrac account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "password" + ], + "title": "connect_ontrac_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Purolator account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "activation_key": { + "description": "Activation key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "activation_key", + "nickname" + ], + "title": "connect_purolator_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Royal Mail account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "city": { + "description": "City", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "Company name", + "minLength": 1, + "type": "string" + }, + "contact_name": { + "description": "Contact name", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "oba_email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The oba email address" + }, + "phone": { + "description": "Phone", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal code", + "minLength": 1, + "type": "string" + }, + "street_line1": { + "description": "Street line1", + "minLength": 1, + "type": "string" + }, + "street_line2": { + "description": "Street line2", + "minLength": 1, + "type": "string" + }, + "street_line3": { + "description": "Street line3", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "contact_name", + "city", + "postal_code", + "nickname" + ], + "title": "connect_royal_mail_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A RR Donnelley account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_rr_donnelley_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A SEKO account information request body", + "properties": { + "access_key": { + "description": "Seko Account Access Key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "access_key" + ], + "title": "connect_seko_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Sendle account information request body", + "properties": { + "api_key": { + "description": "API key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "sendle_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the sendle" + } + }, + "required": [ + "nickname", + "sendle_id", + "api_key" + ], + "title": "connect_sendle_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Stamps account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_stamps_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A UPS account information request body. The location header from this call should be used to redirect to UPS for sign in.", + "properties": { + "account_country_code": { + "description": "Account Country Code", + "minLength": 1, + "type": "string" + }, + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "account_postal_code": { + "description": "Account Postal Code", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "account_postal_code", + "account_country_code" + ], + "title": "connect_ups_request_body", + "type": "object" + } + ], + "title": "connect_carrier_request_body" + }, + "connect_carrier_response_body": { + "additionalProperties": false, + "description": "A connect account response body", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier" + } + }, + "required": [ + "carrier_id" + ], + "title": "connect_carrier_response_body", + "type": "object" + }, + "connect_dhl_ecommerce_request_body": { + "additionalProperties": false, + "description": "A DHL Ecommerce account information request body", + "properties": { + "account_number": { + "deprecated": true, + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "ancillary_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "api_key": { + "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", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "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", + "minLength": 1, + "type": "string" + }, + "client_id": { + "description": "The client id", + "minLength": 1, + "type": "string" + }, + "distribution_center": { + "description": "The distribution center", + "minLength": 1, + "type": "string" + }, + "ftp_password": { + "deprecated": true, + "description": "FTP password", + "minLength": 1, + "type": "string" + }, + "ftp_username": { + "deprecated": true, + "description": "FTP username", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "A nickname to help you identify this account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The account password", + "minLength": 1, + "type": "string" + }, + "pickup_number": { + "description": "The pickup number", + "minLength": 1, + "type": "string" + }, + "registration_id": { + "type": "string" + }, + "software_name": { + "type": "string" + }, + "sold_to": { + "description": "Sold To field", + "type": "string" + }, + "username": { + "description": "The account username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "client_id", + "username", + "password", + "pickup_number", + "distribution_center" + ], + "title": "connect_dhl_ecommerce_request_body", + "type": "object" + }, + "connect_dhl_express_au_request_body": { + "additionalProperties": false, + "description": "A DHL Express AU account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_au_request_body", + "type": "object" + }, + "connect_dhl_express_ca_request_body": { + "additionalProperties": false, + "description": "A DHL Express CA account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_ca_request_body", + "type": "object" + }, + "connect_dhl_express_request_body": { + "additionalProperties": false, + "description": "A DHL express account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Required if site id is provided", + "minLength": 1, + "type": "string" + }, + "site_id": { + "description": "Required if password is provided", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_request_body", + "type": "object" + }, + "connect_dhl_express_uk_request_body": { + "additionalProperties": false, + "description": "A DHL Express UK account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "site_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the site" + } + }, + "required": [ + "account_number", + "site_id", + "password", + "nickname" + ], + "title": "connect_dhl_express_uk_request_body", + "type": "object" + }, + "connect_dpd_request_body": { + "additionalProperties": false, + "description": "A DPD account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "password", + "nickname" + ], + "title": "connect_dpd_request_body", + "type": "object" + }, + "connect_endicia_request_body": { + "additionalProperties": false, + "description": "An Endicia account information request body", + "properties": { + "account": { + "description": "Account", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "passphrase": { + "description": "Passphrase", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account", + "passphrase" + ], + "title": "connect_endicia_request_body", + "type": "object" + }, + "connect_fedex_request_body": { + "additionalProperties": false, + "description": "A Fedex account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "address1": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "address2": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "agree_to_eula": { + "description": "Boolean signaling agreement to the Fedex End User License Agreement", + "type": "boolean" + }, + "city": { + "description": "The city", + "minLength": 1, + "type": "string" + }, + "company": { + "description": "The company", + "minLength": 1, + "type": "string" + }, + "country_code": { + "description": "Country code", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "first_name": { + "description": "First name", + "minLength": 1, + "type": "string" + }, + "last_name": { + "description": "Last name", + "minLength": 1, + "type": "string" + }, + "meter_number": { + "description": "Meter number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal Code", + "minLength": 1, + "type": "string" + }, + "state": { + "description": "State", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "address1", + "city", + "country_code", + "email", + "first_name", + "last_name", + "phone", + "postal_code", + "state", + "nickname", + "agree_to_eula" + ], + "title": "connect_fedex_request_body", + "type": "object" + }, + "connect_fedex_uk_request_body": { + "additionalProperties": false, + "description": "A Fedex UK account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "address1": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "address2": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "agree_to_eula": { + "description": "Boolean signaling agreement to the Fedex End User License Agreement", + "type": "boolean" + }, + "city": { + "description": "The city", + "minLength": 1, + "type": "string" + }, + "company": { + "description": "The company", + "minLength": 1, + "type": "string" + }, + "country_code": { + "description": "Country code", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "first_name": { + "description": "First name", + "minLength": 1, + "type": "string" + }, + "last_name": { + "description": "Last name", + "minLength": 1, + "type": "string" + }, + "meter_number": { + "description": "Meter number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal Code", + "minLength": 1, + "type": "string" + }, + "state": { + "description": "State", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "address1", + "city", + "country_code", + "email", + "first_name", + "last_name", + "phone", + "postal_code", + "state", + "nickname", + "agree_to_eula" + ], + "title": "connect_fedex_uk_request_body", + "type": "object" + }, + "connect_firstmile_request_body": { + "additionalProperties": false, + "description": "A First Mile account information request body", + "properties": { + "mailer_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the mailer" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "profile_name": { + "description": "Profile name", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "mailer_id", + "password" + ], + "title": "connect_firstmile_request_body", + "type": "object" + }, + "connect_imex_request_body": { + "additionalProperties": false, + "description": "An Imex account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_imex_request_body", + "type": "object" + }, + "connect_insurer_request_body": { + "additionalProperties": false, + "description": "A create shipsurance connection request body", + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "policy_id": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "email", + "policy_id" + ], + "title": "connect_insurer_request_body", + "type": "object" + }, + "connect_insurer_response_body": { + "title": "connect_insurer_response_body", + "type": "object" + }, + "connect_lasership_request_body": { + "additionalProperties": false, + "description": "A Lasership account information request body", + "properties": { + "Address": { + "description": "Address", + "type": "string," + }, + "Address2": { + "description": "Address2", + "type": "string," + }, + "AttrAlcohol": { + "description": "Set this to true if your shipments will always contain Alcohol", + "type": "boolean," + }, + "AttrControlledSubstance": { + "description": "Set this to true if your shipments will always contain Controlled Substances", + "type": "boolean," + }, + "AttrDryIce": { + "description": "Set this to true if your shipments will always contain DryIce", + "type": "boolean," + }, + "AttrExplosive": { + "description": "Set this to true if your shipments will always contain Explosives", + "type": "boolean," + }, + "AttrHazmat": { + "description": "Set this to true if your shipments will always contain Hazmat", + "type": "boolean," + }, + "AttrNoRTS": { + "description": "Set this to true if your shipments will always use \"No Return To Sender\"", + "type": "boolean," + }, + "AttrPerishable": { + "description": "Set this to true if your shipments will always be Perishable", + "type": "boolean," + }, + "AttrRefrigerated": { + "description": "Set this to true if your shipments will always require Refrigeration", + "type": "boolean," + }, + "AttrTwoPersons": { + "description": "Set this to true if your shipments will always require Two Persons", + "type": "boolean," + }, + "City": { + "description": "City", + "type": "string," + }, + "Email": { + "description": "Email", + "type": "string," + }, + "Phone": { + "description": "Phone", + "type": "string," + }, + "PostalCode": { + "description": "PostalCode", + "type": "string," + }, + "State": { + "description": "State", + "type": "string," + }, + "country": { + "description": "Country", + "type": "string," + }, + "customer_branch": { + "description": "Customer Branch", + "minLength": 1, + "type": "string" + }, + "declare_piece_attributes_separately_for_every_shipment": { + "default": false, + "description": "Declare piece attributes separately for every shipment, overrides individual attribute below.", + "type": "boolean," + }, + "facility_code": { + "description": "Facility Code", + "type": "string," + }, + "instructions": { + "description": "Instructions", + "type": "string," + }, + "lasership_critical_entry_time": { + "description": "Critical Entry Time (local time)", + "type": "string," + }, + "lasership_critical_pull_time": { + "description": "Critical Pull Time (local time)", + "type": "string," + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "web_services_id": { + "description": "Web Service ID (WSID)", + "minLength": 1, + "type": "string" + }, + "web_services_key": { + "description": "Web Service Key (WSKey)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "web_services_id", + "web_services_key", + "customer_branch", + "Address", + "PostalCode", + "City", + "State", + "lasership_critical_pull_time", + "lasership_critical_entry_time" + ], + "title": "connect_lasership_request_body", + "type": "object" + }, + "connect_newgistics_request_body": { + "additionalProperties": false, + "description": "A Newgistics account information request body", + "properties": { + "induction_site": { + "description": "Induction site", + "minLength": 1, + "type": "string" + }, + "mailer_id": { + "description": "Mailer id", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "merchant_id": { + "description": "Merchant id", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "induction_site", + "nickname" + ], + "title": "connect_newgistics_request_body", + "type": "object" + }, + "connect_ontrac_request_body": { + "additionalProperties": false, + "description": "An Ontrac account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "password" + ], + "title": "connect_ontrac_request_body", + "type": "object" + }, + "connect_purolator_request_body": { + "additionalProperties": false, + "description": "A Purolator account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "activation_key": { + "description": "Activation key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "activation_key", + "nickname" + ], + "title": "connect_purolator_request_body", + "type": "object" + }, + "connect_royal_mail_request_body": { + "additionalProperties": false, + "description": "A Royal Mail account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "city": { + "description": "City", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "Company name", + "minLength": 1, + "type": "string" + }, + "contact_name": { + "description": "Contact name", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "oba_email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The oba email address" + }, + "phone": { + "description": "Phone", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal code", + "minLength": 1, + "type": "string" + }, + "street_line1": { + "description": "Street line1", + "minLength": 1, + "type": "string" + }, + "street_line2": { + "description": "Street line2", + "minLength": 1, + "type": "string" + }, + "street_line3": { + "description": "Street line3", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "contact_name", + "city", + "postal_code", + "nickname" + ], + "title": "connect_royal_mail_request_body", + "type": "object" + }, + "connect_rr_donnelley_request_body": { + "additionalProperties": false, + "description": "A RR Donnelley account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_rr_donnelley_request_body", + "type": "object" + }, + "connect_seko_request_body": { + "additionalProperties": false, + "description": "A SEKO account information request body", + "properties": { + "access_key": { + "description": "Seko Account Access Key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "access_key" + ], + "title": "connect_seko_request_body", + "type": "object" + }, + "connect_sendle_request_body": { + "additionalProperties": false, + "description": "A Sendle account information request body", + "properties": { + "api_key": { + "description": "API key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "sendle_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the sendle" + } + }, + "required": [ + "nickname", + "sendle_id", + "api_key" + ], + "title": "connect_sendle_request_body", + "type": "object" + }, + "connect_stamps_request_body": { + "additionalProperties": false, + "description": "A Stamps account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_stamps_request_body", + "type": "object" + }, + "connect_ups_request_body": { + "additionalProperties": false, + "description": "A UPS account information request body. The location header from this call should be used to redirect to UPS for sign in.", + "properties": { + "account_country_code": { + "description": "Account Country Code", + "minLength": 1, + "type": "string" + }, + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "account_postal_code": { + "description": "Account Postal Code", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "account_postal_code", + "account_country_code" + ], + "title": "connect_ups_request_body", + "type": "object" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "country_code": { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + }, + "create_account_settings_image_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "A ShipEngine account settings images request body", + "required": [ + "name", + "image_content_type", + "image_data" + ], + "title": "create_account_settings_image_request_body", + "type": "object" + }, + "create_and_process_batch_request_body": { + "additionalProperties": false, + "description": "A create and process batch request body", + "properties": { + "batch_notes": { + "description": "Add custom messages for a particular batch", + "example": "This is my batch", + "minLength": 1, + "type": "string" + }, + "external_batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the external batch" + }, + "process_labels": { + "description": "The information used to process the batch", + "properties": { + "create_batch_and_process_labels": { + "description": "When 'true', the batch will be enqueued for processing", + "type": "boolean" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The Ship date the batch is being processed for" + } + }, + "type": "object" + }, + "rate_ids": { + "description": "Array of rate IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "shipment_ids": { + "description": "Array of shipment IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_and_process_batch_request_body", + "type": "object" + }, + "create_and_validate_shipment": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "properties": { + "address_validation": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation" + }, + "errors": { + "deprecated": true, + "description": "An array of errors that occurred while creating shipment.", + "items": { + "description": "An error that occurred while creating a shipment.", + "example": "Parameter value '100000000.00' is out of range.", + "minLength": 1, + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "title": "create_shipment_response_body_fields", + "type": "object" + } + ], + "description": "A create and validate shipment resource", + "title": "create_and_validate_shipment", + "type": "object" + }, + "create_batch_request": { + "oneOf": [ + { + "additionalProperties": false, + "description": "A create batch request body", + "properties": { + "batch_notes": { + "description": "Add custom messages for a particular batch", + "example": "This is my batch", + "minLength": 1, + "type": "string" + }, + "external_batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the external batch" + }, + "rate_ids": { + "description": "Array of rate IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "shipment_ids": { + "description": "Array of shipment IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_batch_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A create and process batch request body", + "properties": { + "batch_notes": { + "description": "Add custom messages for a particular batch", + "example": "This is my batch", + "minLength": 1, + "type": "string" + }, + "external_batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the external batch" + }, + "process_labels": { + "description": "The information used to process the batch", + "properties": { + "create_batch_and_process_labels": { + "description": "When 'true', the batch will be enqueued for processing", + "type": "boolean" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The Ship date the batch is being processed for" + } + }, + "type": "object" + }, + "rate_ids": { + "description": "Array of rate IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "shipment_ids": { + "description": "Array of shipment IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_and_process_batch_request_body", + "type": "object" + } + ], + "title": "create_batch_request" + }, + "create_batch_request_body": { + "additionalProperties": false, + "description": "A create batch request body", + "properties": { + "batch_notes": { + "description": "Add custom messages for a particular batch", + "example": "This is my batch", + "minLength": 1, + "type": "string" + }, + "external_batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the external batch" + }, + "rate_ids": { + "description": "Array of rate IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "shipment_ids": { + "description": "Array of shipment IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_batch_request_body", + "type": "object" + }, + "create_batch_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "A create batch response body", + "title": "create_batch_response_body", + "type": "object" + }, + "create_combined_label_document_request_body": { + "additionalProperties": false, + "description": "A create combined label document request body", + "properties": { + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "inline" + }, + "label_format": { + "description": "The file format for the combined label document; note that currently only `\"pdf\"` is supported.", + "enum": [ + "pdf" + ], + "type": "string" + }, + "label_ids": { + "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", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_combined_label_document_request_body", + "type": "object" + }, + "create_combined_label_document_response_body.yaml": { + "additionalProperties": false, + "description": "A create combined label document response body", + "properties": { + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The download for the combined label document", + "readOnly": true + } + }, + "title": "create_combined_label_document_response_body.yaml", + "type": "object" + }, + "create_label_from_rate_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A purchase label without shipment resource", + "properties": { + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url" + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ] + } + }, + "title": "purchase_label_without_shipment", + "type": "object" + } + ], + "description": "A purchase label without shipment request body", + "properties": { + "custom_field1": { + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field1", + "type": "string" + }, + "custom_field2": { + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field2", + "type": "string" + }, + "custom_field3": { + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field3", + "type": "string" + } + }, + "title": "create_label_from_rate_request_body", + "type": "object" + }, + "create_label_from_rate_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create label from rate response body", + "title": "create_label_from_rate_response_body", + "type": "object" + }, + "create_label_from_shipment_request_body": { + "additionalProperties": false, + "description": "A purchase label without shipment request body", + "properties": { + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url" + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ] + } + }, + "title": "create_label_from_shipment_request_body", + "type": "object" + }, + "create_label_from_shipment_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create label from shipment response body", + "title": "create_label_from_shipment_response_body", + "type": "object" + }, + "create_label_rate_shopper_request_body": { + "additionalProperties": false, + "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", + "properties": { + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment_for_rate_shopper", + "type": "object" + } + ], + "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" + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation", + "writeOnly": true + } + }, + "required": [ + "shipment" + ], + "title": "create_label_rate_shopper_request_body", + "type": "object" + }, + "create_label_rate_shopper_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "The response from creating a label using the Rate Shopper. Includes all standard\nlabel information plus the rate_shopper_id indicating which strategy was used.\n", + "properties": { + "rate_shopper_id": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ], + "description": "The rate selection strategy that was used to create this label. This will\nmatch the rate_shopper_id provided in the request path.\n", + "readOnly": true + } + }, + "title": "create_label_rate_shopper_response_body", + "type": "object" + }, + "create_label_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "required": [ + "phone", + "country_code" + ], + "title": "shipping_address_from", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + } + }, + "required": [ + "carrier_id", + "service_code", + "ship_to", + "packages" + ], + "title": "shipment_request", + "type": "object" + } + ], + "description": "The shipment information used to generate the label" + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation", + "writeOnly": true + } + }, + "title": "label_request", + "type": "object" + } + ], + "description": "A purchase label request body", + "properties": { + "ship_from_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + }, + "ship_to_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + } + }, + "required": [ + "shipment" + ], + "title": "create_label_request_body", + "type": "object" + }, + "create_label_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create label response body", + "required": [ + "label_id", + "status", + "shipment_id", + "external_shipment_id", + "external_order_id", + "ship_date", + "created_at", + "shipment_cost", + "insurance_cost", + "tracking_number", + "is_international", + "batch_id", + "carrier_id", + "service_code", + "voided", + "label_image_id", + "label_format", + "label_layout", + "trackable", + "carrier_code", + "tracking_status", + "label_download", + "form_download", + "qr_code_download", + "paperless_download", + "insurance_claim", + "packages", + "is_return_label", + "rma_number", + "charge_event", + "package_code", + "display_scheme", + "ship_to" + ], + "title": "create_label_response_body", + "type": "object" + }, + "create_manifest_by_object_request_body": { + "additionalProperties": false, + "description": "A create manifest request body", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier" + }, + "excluded_label_ids": { + "description": "The list of label ids to exclude from the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be excluded from the manifest" + }, + "type": "array" + }, + "label_ids": { + "description": "The list of label ids to include for the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be included for the manifest" + }, + "type": "array" + }, + "ship_date": { + "description": "The ship date that the shipment will be sent out on", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse" + } + }, + "required": [ + "carrier_id", + "warehouse_id", + "ship_date" + ], + "title": "create_manifest_by_object_request_body", + "type": "object" + }, + "create_manifest_label_ids_request_body": { + "additionalProperties": false, + "description": "A create manifest request body", + "properties": { + "label_ids": { + "description": "The list of label ids to include in the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be included in the manifest" + }, + "type": "array" + } + }, + "required": [ + "label_ids" + ], + "title": "create_manifest_label_ids_request_body", + "type": "object" + }, + "create_manifest_request_body": { + "oneOf": [ + { + "additionalProperties": false, + "description": "A create manifest request body", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier" + }, + "excluded_label_ids": { + "description": "The list of label ids to exclude from the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be excluded from the manifest" + }, + "type": "array" + }, + "label_ids": { + "description": "The list of label ids to include for the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be included for the manifest" + }, + "type": "array" + }, + "ship_date": { + "description": "The ship date that the shipment will be sent out on", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse" + } + }, + "required": [ + "carrier_id", + "warehouse_id", + "ship_date" + ], + "title": "create_manifest_by_object_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A create manifest request body", + "properties": { + "label_ids": { + "description": "The list of label ids to include in the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be included in the manifest" + }, + "type": "array" + } + }, + "required": [ + "label_ids" + ], + "title": "create_manifest_label_ids_request_body", + "type": "object" + } + ], + "title": "create_manifest_request_body" + }, + "create_manifest_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "An array of manifest resources", + "properties": { + "manifests": { + "description": "Resulting Manifests", + "items": { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An array of manifest requests", + "properties": { + "manifest_requests": { + "description": "Resulting manifest requests with statuses", + "items": { + "additionalProperties": false, + "description": "A reference to the manifest request", + "properties": { + "manifest_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies a manifest request", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible statuses of a manifest request", + "enum": [ + "in_progress", + "completed" + ], + "title": "manifest_request_status", + "type": "string" + } + ] + } + }, + "title": "manifest_request", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests_requests", + "type": "object" + }, + { + "additionalProperties": false, + "description": "Deprecated manifest resource", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the carrier" + }, + "created_at": { + "deprecated": true, + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the form" + }, + "label_ids": { + "deprecated": true, + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "deprecated": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the manifest" + }, + "ship_date": { + "deprecated": true, + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "shipments": { + "deprecated": true, + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "deprecated": true, + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the warehouse" + } + }, + "title": "deprecated_manifest", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_with_label_id_response_body", + "type": "object" + } + ], + "description": "A create manifest response body", + "required": [ + "manifest_id", + "form_id", + "created_at", + "ship_date", + "shipments", + "warehouse_id", + "submission_id", + "carrier_id", + "manifest_download" + ], + "title": "create_manifest_response_body", + "type": "object" + }, + "create_package_type_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "A create package type request body", + "title": "create_package_type_request_body", + "type": "object" + }, + "create_package_type_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "A create package type response body", + "title": "create_package_type_response_body", + "type": "object" + }, + "create_return_label_request_body": { + "additionalProperties": false, + "description": "A create return label request body", + "properties": { + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "rma_number": { + "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", + "nullable": true, + "type": "string" + } + }, + "title": "create_return_label_request_body", + "type": "object" + }, + "create_return_label_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create return label response body", + "title": "create_return_label_response_body", + "type": "object" + }, + "create_shipment_response_body_fields": { + "properties": { + "address_validation": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation" + }, + "errors": { + "deprecated": true, + "description": "An array of errors that occurred while creating shipment.", + "items": { + "description": "An error that occurred while creating a shipment.", + "example": "Parameter value '100000000.00' is out of range.", + "minLength": 1, + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "title": "create_shipment_response_body_fields", + "type": "object" + }, + "create_shipments_request_body": { + "additionalProperties": false, + "description": "A create shipments request body", + "properties": { + "shipments": { + "description": "An array of shipments to be created.", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "shipments" + ], + "title": "create_shipments_request_body", + "type": "object" + }, + "create_shipments_response_body": { + "additionalProperties": false, + "description": "A create shipments response body", + "properties": { + "has_errors": { + "default": false, + "description": "Indicates if errors occured while creating the shipments", + "type": "boolean" + }, + "shipments": { + "description": "An array of shipments that were created.", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "properties": { + "address_validation": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation" + }, + "errors": { + "deprecated": true, + "description": "An array of errors that occurred while creating shipment.", + "items": { + "description": "An error that occurred while creating a shipment.", + "example": "Parameter value '100000000.00' is out of range.", + "minLength": 1, + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "title": "create_shipment_response_body_fields", + "type": "object" + } + ], + "description": "A create and validate shipment resource", + "title": "create_and_validate_shipment", + "type": "object" + } + ], + "description": "The shipment that was created." + }, + "type": "array" + } + }, + "required": [ + "has_errors", + "shipments" + ], + "title": "create_shipments_response_body", + "type": "object" + }, + "create_tag_request_body": { + "additionalProperties": false, + "description": "A create tag request body", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "create_tag_request_body", + "type": "object" + }, + "create_tag_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ], + "description": "Response body for creating tags", + "title": "create_tag_response_body", + "type": "object" + }, + "create_warehouse_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "A create warehouse request body", + "required": [ + "name", + "origin_address" + ], + "title": "create_warehouse_request_body", + "type": "object" + }, + "create_warehouse_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "A create warehouse response body", + "required": [ + "warehouse_id", + "name", + "created_at", + "origin_address", + "return_address" + ], + "title": "create_warehouse_response_body", + "type": "object" + }, + "create_webhook_request_body": { + "additionalProperties": false, + "description": "A create webhook request body", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My New Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + } + }, + "required": [ + "event", + "url" + ], + "title": "create_webhook_request_body", + "type": "object" + }, + "create_webhook_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A webhook", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + }, + "webhook_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the webhook", + "readOnly": true + } + }, + "title": "webhook", + "type": "object" + } + ], + "description": "A webhook response body", + "required": [ + "webhook_id", + "url", + "event" + ], + "title": "create_webhook_response_body", + "type": "object" + }, + "currency": { + "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", + "title": "currency", + "type": "string" + }, + "customs_item": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "dangerous_amount": { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + }, + "dangerous_goods": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "date": { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + }, + "date_time": { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + }, + "default_label_layout": { + "description": "The possible default label layout values", + "enum": [ + "4x6", + "Letter" + ], + "title": "default_label_layout", + "type": "string" + }, + "delete_pickup_by_id_response_body": { + "allOf": [ + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A delete scheduled pickup response body", + "properties": { + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ] + } + }, + "required": [ + "pickup_id" + ], + "title": "delete_scheduled_pickup_response_body", + "type": "object" + } + ], + "title": "delete_pickup_by_id_response_body" + }, + "delete_scheduled_pickup_response_body": { + "additionalProperties": false, + "description": "A delete scheduled pickup response body", + "properties": { + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ] + } + }, + "required": [ + "pickup_id" + ], + "title": "delete_scheduled_pickup_response_body", + "type": "object" + }, + "delivery_confirmation": { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + }, + "deprecated_manifest": { + "additionalProperties": false, + "description": "Deprecated manifest resource", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the carrier" + }, + "created_at": { + "deprecated": true, + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the form" + }, + "label_ids": { + "deprecated": true, + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "deprecated": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the manifest" + }, + "ship_date": { + "deprecated": true, + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "shipments": { + "deprecated": true, + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "deprecated": true, + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the warehouse" + } + }, + "title": "deprecated_manifest", + "type": "object" + }, + "dhl_express_account_settings": { + "additionalProperties": false, + "description": "A DHL Express account settings", + "properties": { + "is_primary_account": { + "description": "Indicates if this is primary account", + "type": "boolean" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "should_hide_account_number_on_archive_doc": { + "description": "Indicates if the account number should be hidden on the archive documentation", + "type": "boolean" + } + }, + "title": "dhl_express_account_settings", + "type": "object" + }, + "dhl_express_settings_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A DHL Express account settings", + "properties": { + "is_primary_account": { + "description": "Indicates if this is primary account", + "type": "boolean" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "should_hide_account_number_on_archive_doc": { + "description": "Indicates if the account number should be hidden on the archive documentation", + "type": "boolean" + } + }, + "title": "dhl_express_account_settings", + "type": "object" + } + ], + "description": "A DHL Express response body", + "title": "dhl_express_settings_response_body", + "type": "object" + }, + "dimension_unit": { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + }, + "dimensions": { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + }, + "disconnect_insurer_response_body": { + "title": "disconnect_insurer_response_body", + "type": "object" + }, + "display_scheme": { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + }, + "download_file_pdf_response_body": { + "format": "binary", + "title": "download_file_pdf_response_body", + "type": "string" + }, + "download_file_png_response_body": { + "format": "binary", + "title": "download_file_png_response_body", + "type": "string" + }, + "download_file_zpl_response_body": { + "format": "binary", + "title": "download_file_zpl_response_body", + "type": "string" + }, + "email": { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + }, + "empty_response_body": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + }, + "error": { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + }, + "error_code": { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + }, + "error_response_body": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + }, + "error_source": { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + }, + "error_type": { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + }, + "error_with_label_id_response_body": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_with_label_id_response_body", + "type": "object" + }, + "estimate_rates_request_body": { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ] + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ] + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The dimensions of the package" + }, + "from_city_locality": { + "description": "from postal code", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "from_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "from_postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "from_state_province": { + "description": "From state province", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "ship date", + "type": "string" + }, + "to_city_locality": { + "description": "The city locality the package is being shipped to", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "to_postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "to_state_province": { + "description": "To state province", + "example": "Houston", + "minLength": 1, + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the package" + } + }, + "title": "rate_estimate_options", + "type": "object" + } + ], + "description": "A rate estimate request body", + "oneOf": [ + { + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the carrier" + } + }, + "title": "rate_estimate_by_carrier_id", + "type": "object" + }, + { + "properties": { + "carrier_ids": { + "description": "Array of Carrier Ids", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier id", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "title": "rate_estimate_by_carrier_ids", + "type": "object" + } + ], + "required": [ + "from_country_code", + "from_postal_code", + "from_city_locality", + "from_state_province", + "to_country_code", + "to_postal_code", + "to_city_locality", + "to_state_province", + "weight", + "ship_date" + ], + "title": "estimate_rates_request_body", + "type": "object" + }, + "estimate_rates_response_body": { + "description": "A rate estimate response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate estimate", + "properties": { + "carrier_code": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate_estimate", + "type": "object" + } + ] + }, + "title": "estimate_rates_response_body", + "type": "array" + }, + "estimated_import_charges": { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + }, + "fedex_account_settings": { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + }, + "fedex_account_settings_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + } + ], + "description": "A Fedex account settings request body", + "title": "fedex_account_settings_request_body", + "type": "object" + }, + "fedex_pickup_type": { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + }, + "fedex_settings_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + } + ], + "description": "A Fedex account settings request body", + "title": "fedex_account_settings_request_body", + "type": "object" + } + ], + "description": "A Fedex settings response body", + "title": "fedex_settings_response_body", + "type": "object" + }, + "get_account_settings_images_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "A get account images by id response body", + "title": "get_account_settings_images_response_body", + "type": "object" + }, + "get_account_settings_response_body": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account settings response body", + "properties": { + "default_label_layout": { + "allOf": [ + { + "description": "The possible default label layout values", + "enum": [ + "4x6", + "Letter" + ], + "title": "default_label_layout", + "type": "string" + } + ] + } + }, + "title": "account_settings", + "type": "object" + } + ], + "description": "An account settings list response body", + "title": "list_account_settings_body", + "type": "object" + } + ], + "title": "get_account_settings_response_body" + }, + "get_batch_by_external_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "A get batch by external id response body", + "title": "get_batch_by_external_id_response_body", + "type": "object" + }, + "get_batch_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "A get batch by id response body", + "title": "get_batch_by_id_response_body", + "type": "object" + }, + "get_carrier_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n", + "properties": { + "account_number": { + "description": "The account number that the carrier is connected to.", + "example": "account_570827", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "allows_returns": { + "description": "The carrier has services that support return shipments.", + "readOnly": true, + "type": "boolean" + }, + "balance": { + "description": "Current available balance", + "example": 3799.52, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier.", + "readOnly": true + }, + "connection_status": { + "description": "The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.", + "enum": [ + "pending_approval", + "approved" + ], + "readOnly": true, + "type": "string" + }, + "disabled_by_billing_plan": { + "description": "The carrier is disabled by the current ShipEngine account's billing plan.", + "readOnly": true, + "type": "boolean" + }, + "friendly_name": { + "description": "Screen readable name", + "example": "Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "funding_source_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Funding source ID for the carrier", + "nullable": true, + "readOnly": true + }, + "has_multi_package_supporting_services": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "nickname": { + "description": "Nickname given to the account when initially setting up the carrier.", + "example": "ShipEngine Account - Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "options": { + "description": "A list of options that are available to that carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "packages": { + "description": "A list of package types that are supported by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "primary": { + "description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation", + "readOnly": true, + "type": "boolean" + }, + "requires_funded_amount": { + "description": "Indicates whether the carrier requires funding to use its services", + "readOnly": true, + "type": "boolean" + }, + "send_rates": { + "description": "The carrier provides rates for the shipment.", + "readOnly": true, + "type": "boolean" + }, + "services": { + "description": "A list of services that are offered by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "supports_label_messages": { + "description": "The carrier supports adding custom label messages to an order.", + "readOnly": true, + "type": "boolean" + }, + "supports_user_managed_rates": { + "description": "The carrier supports user-managed rates for shipments.", + "readOnly": true, + "type": "boolean" + } + }, + "title": "carrier", + "type": "object" + } + ], + "description": "A get carrier by id response body", + "title": "get_carrier_by_id_response_body", + "type": "object" + }, + "get_carrier_options_response_body": { + "additionalProperties": false, + "description": "A carrier list options response body", + "properties": { + "options": { + "description": "AN array of carrier options", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "description": "Carrer options", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "get_carrier_options_response_body", + "type": "object" + }, + "get_carrier_settings_response_body": { + "oneOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A DHL Express account settings", + "properties": { + "is_primary_account": { + "description": "Indicates if this is primary account", + "type": "boolean" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "should_hide_account_number_on_archive_doc": { + "description": "Indicates if the account number should be hidden on the archive documentation", + "type": "boolean" + } + }, + "title": "dhl_express_account_settings", + "type": "object" + } + ], + "description": "A DHL Express response body", + "title": "dhl_express_settings_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + } + ], + "description": "A Fedex account settings request body", + "title": "fedex_account_settings_request_body", + "type": "object" + } + ], + "description": "A Fedex settings response body", + "title": "fedex_settings_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "UPS account settings", + "properties": { + "account_postal_code": { + "description": "account postal code", + "minLength": 5, + "type": "string" + }, + "invoice": { + "allOf": [ + { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + } + ], + "description": "The invoice" + }, + "is_primary_account": { + "description": "Indicates if this is the primary UPS account", + "type": "boolean" + }, + "mail_innovations_cost_center": { + "description": "mail innovations cost center", + "minLength": 0, + "type": "string" + }, + "mail_innovations_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "nickname": { + "description": "nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + } + ] + }, + "use_carbon_neutral_shipping_program": { + "description": "The use carbon neutral shipping program", + "type": "boolean" + }, + "use_consolidation_services": { + "description": "The use consolidation services", + "type": "boolean" + }, + "use_ground_freight_pricing": { + "description": "The use ground freight pricing", + "type": "boolean" + }, + "use_negotiated_rates": { + "description": "The use negotiated rates", + "type": "boolean" + }, + "use_order_number_on_mail_innovations_labels": { + "description": "The use order number on mail innovations labels", + "type": "boolean" + } + }, + "title": "ups_account_settings", + "type": "object" + } + ], + "description": "A UPS settings response body", + "title": "ups_settings_response_body", + "type": "object" + } + ], + "title": "get_carrier_settings_response_body" + }, + "get_carriers_response_body": { + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier list response body", + "properties": { + "carriers": { + "description": "The carrier response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n", + "properties": { + "account_number": { + "description": "The account number that the carrier is connected to.", + "example": "account_570827", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "allows_returns": { + "description": "The carrier has services that support return shipments.", + "readOnly": true, + "type": "boolean" + }, + "balance": { + "description": "Current available balance", + "example": 3799.52, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier.", + "readOnly": true + }, + "connection_status": { + "description": "The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.", + "enum": [ + "pending_approval", + "approved" + ], + "readOnly": true, + "type": "string" + }, + "disabled_by_billing_plan": { + "description": "The carrier is disabled by the current ShipEngine account's billing plan.", + "readOnly": true, + "type": "boolean" + }, + "friendly_name": { + "description": "Screen readable name", + "example": "Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "funding_source_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Funding source ID for the carrier", + "nullable": true, + "readOnly": true + }, + "has_multi_package_supporting_services": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "nickname": { + "description": "Nickname given to the account when initially setting up the carrier.", + "example": "ShipEngine Account - Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "options": { + "description": "A list of options that are available to that carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "packages": { + "description": "A list of package types that are supported by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "primary": { + "description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation", + "readOnly": true, + "type": "boolean" + }, + "requires_funded_amount": { + "description": "Indicates whether the carrier requires funding to use its services", + "readOnly": true, + "type": "boolean" + }, + "send_rates": { + "description": "The carrier provides rates for the shipment.", + "readOnly": true, + "type": "boolean" + }, + "services": { + "description": "A list of services that are offered by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "supports_label_messages": { + "description": "The carrier supports adding custom label messages to an order.", + "readOnly": true, + "type": "boolean" + }, + "supports_user_managed_rates": { + "description": "The carrier supports user-managed rates for shipments.", + "readOnly": true, + "type": "boolean" + } + }, + "title": "carrier", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "carriers" + ], + "title": "list_carriers_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "get_carriers_response_body" + }, + "get_insurance_balance_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "A get insurance balance response body", + "title": "get_insurance_balance_response_body", + "type": "object" + }, + "get_label_by_external_shipment_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A get label by external shipment id response body", + "title": "get_label_by_external_shipment_id_response_body", + "type": "object" + }, + "get_label_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A get label by id response body", + "title": "get_label_by_id_response_body", + "type": "object" + }, + "get_manifest_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + } + ], + "description": "A get manifest by id response body", + "required": [ + "manifest_id", + "form_id", + "created_at", + "ship_date", + "shipments", + "warehouse_id", + "submission_id", + "carrier_id", + "manifest_download", + "label_ids" + ], + "title": "get_manifest_by_id_response_body", + "type": "object" + }, + "get_package_type_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "A get package type by id response body", + "title": "get_package_type_by_id_response_body", + "type": "object" + }, + "get_pickup_by_id_response_body": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ], + "description": "A pickup response body", + "required": [ + "pickup", + "pickup_id", + "label_ids", + "created_at", + "carrier_id", + "warehouse_id", + "pickup_address", + "contact_details", + "notes", + "pickup_window", + "confirmation_number" + ], + "title": "pickup_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "get_pickup_by_id_response_body" + }, + "get_pickups_response_body": { + "allOf": [ + { + "additionalProperties": false, + "description": "A list pickup response body", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "description": "Helpful links to other pages of results", + "readOnly": true + }, + "page": { + "description": "Current page of the list pickups results", + "example": 3, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "description": "Total number of pages for list pickups results", + "example": 4, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pickups": { + "description": "An array of pickups associated with the user's account.", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ] + }, + "type": "array" + }, + "total": { + "description": "The total number of pickups returned", + "example": 3, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "pickups", + "total", + "page", + "pages", + "links" + ], + "title": "list_pickup_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "get_pickups_response_body" + }, + "get_rate_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "A rate response body", + "required": [ + "rates", + "invalid_rates", + "rate_request_id", + "shipment_id", + "created_at", + "status", + "errors" + ], + "title": "get_rate_by_id_response_body", + "type": "object" + }, + "get_service_point_by_id_response_body": { + "description": "A get service point by ID response body", + "properties": { + "service_point": { + "properties": { + "address_line1": { + "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.", + "example": "PLACE DU CANADA", + "type": "string" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "TRUN", + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.", + "example": "My fancy company name", + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "features": { + "description": "Service features", + "items": { + "enum": [ + "drop_off_point", + "pickup_point", + "print_services", + "after_hours_locker", + "after_hours_dropbox" + ], + "type": "string" + }, + "type": "array" + }, + "hours_of_operation": { + "description": "Hours of operation", + "properties": { + "friday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "monday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "saturday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "sunday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "thursday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tuesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "wednesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.842608, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 0.032875, + "format": "double", + "type": "number" + }, + "phone_number": { + "description": "Phone number associated", + "example": "555-555-5555", + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "service_codes": { + "items": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) service code.", + "type": "string" + }, + "type": "array" + }, + "service_point_id": { + "description": "A unique identifier for a carrier drop off point.", + "example": "614940", + "type": "string" + }, + "state_province": { + "description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.", + "example": "TRUN", + "type": "string" + }, + "type": { + "default": "pudo", + "description": "Service point type", + "enum": [ + "pudo", + "locker" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "title": "get_service_point_by_id_response_body", + "type": "object" + }, + "get_service_points_request": { + "oneOf": [ + { + "description": "A get service points request body. Caller must provide exactly one of address_query, address, or lat / long pair.", + "properties": { + "address": { + "description": "Structured address to search by.", + "properties": { + "address_line1": { + "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.", + "example": "1999 Bishop Grandin Blvd.", + "type": "string" + }, + "address_line2": { + "type": "string" + }, + "address_line3": { + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ], + "type": "string" + }, + "state_province": { + "description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.", + "type": "string" + } + }, + "required": [ + "country_code" + ], + "type": "object" + }, + "address_query": { + "description": "Unstructured text to search for service points by.", + "example": "177A Bleecker Street New York", + "type": "string" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.874518928233094, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 2.3591775711639404, + "format": "double", + "type": "number" + }, + "max_results": { + "description": "The maximum number of service points to return", + "example": 25, + "format": "int32", + "type": "integer" + }, + "providers": { + "description": "An array of shipping service providers and service codes", + "items": { + "properties": { + "carrier_id": { + "description": "Uniquely identifies a carrier connection", + "example": "se-123456", + "type": "string" + }, + "service_code": { + "items": { + "description": "Uniquely identifies a shipping service", + "example": "chronoclassic", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "radius": { + "description": "Search radius in kilometers", + "example": 500, + "format": "int32", + "type": "integer" + }, + "shipment": { + "description": "Shipment information to be used for service point selection", + "properties": { + "packages": { + "description": "An array of package dimensions", + "items": { + "properties": { + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + } + }, + "type": "object" + }, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "Shipment total weight" + } + }, + "type": "object" + } + }, + "required": [ + "providers" + ], + "title": "get_service_points_request_body", + "type": "object" + } + ], + "title": "get_service_points_request" + }, + "get_service_points_request_body": { + "description": "A get service points request body. Caller must provide exactly one of address_query, address, or lat / long pair.", + "properties": { + "address": { + "description": "Structured address to search by.", + "properties": { + "address_line1": { + "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.", + "example": "1999 Bishop Grandin Blvd.", + "type": "string" + }, + "address_line2": { + "type": "string" + }, + "address_line3": { + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ], + "type": "string" + }, + "state_province": { + "description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.", + "type": "string" + } + }, + "required": [ + "country_code" + ], + "type": "object" + }, + "address_query": { + "description": "Unstructured text to search for service points by.", + "example": "177A Bleecker Street New York", + "type": "string" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.874518928233094, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 2.3591775711639404, + "format": "double", + "type": "number" + }, + "max_results": { + "description": "The maximum number of service points to return", + "example": 25, + "format": "int32", + "type": "integer" + }, + "providers": { + "description": "An array of shipping service providers and service codes", + "items": { + "properties": { + "carrier_id": { + "description": "Uniquely identifies a carrier connection", + "example": "se-123456", + "type": "string" + }, + "service_code": { + "items": { + "description": "Uniquely identifies a shipping service", + "example": "chronoclassic", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "radius": { + "description": "Search radius in kilometers", + "example": 500, + "format": "int32", + "type": "integer" + }, + "shipment": { + "description": "Shipment information to be used for service point selection", + "properties": { + "packages": { + "description": "An array of package dimensions", + "items": { + "properties": { + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + } + }, + "type": "object" + }, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "Shipment total weight" + } + }, + "type": "object" + } + }, + "required": [ + "providers" + ], + "title": "get_service_points_request_body", + "type": "object" + }, + "get_shipment_by_external_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "A get shipment by external id response body", + "title": "get_shipment_by_external_id_response_body", + "type": "object" + }, + "get_shipment_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "A get shipment by id response body", + "title": "get_shipment_by_id_response_body", + "type": "object" + }, + "get_tracking_log_from_label_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A tracking information resource", + "properties": { + "actual_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "estimated_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "events": { + "description": "The events that have occured during the lifetime of this tracking number.", + "items": { + "additionalProperties": false, + "description": "A track event", + "properties": { + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Carrier timestamp for the event, it is assumed to be the local time of where the event occurred." + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "city_locality": { + "description": "City locality", + "example": "AUSTIN", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "company_name": { + "description": "Company Name", + "example": "Stamps.com", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "description": { + "description": "Event description", + "example": "Delivered, In/At Mailbox", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "event_code": { + "description": "Event Code", + "minLength": 0, + "type": "string" + }, + "latitude": { + "description": "Latitude coordinate of tracking event.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "description": "Longitude coordinate of tracking event.", + "format": "double", + "maximum": 180, + "minimum": -180, + "type": "number" + }, + "occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Timestamp for carrier event" + }, + "postal_code": { + "description": "Postal code", + "example": 78756, + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "proof_of_delivery_url": { + "description": "A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.", + "example": "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png", + "readOnly": true, + "type": "string" + }, + "signer": { + "description": "Signer information", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "state_province": { + "description": "State province", + "example": "TX", + "minLength": 2, + "readOnly": true, + "type": "string" + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "IT" + }, + "status_description": { + "description": "Event Status Description", + "example": "In Transit", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "IN_TRANSIT" + }, + "status_detail_description": { + "description": "Event Status Detail Description", + "example": "Your shipment is on its way between the carrier hubs.", + "minLength": 0, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "occurred_at", + "city_locality", + "state_province", + "postal_code", + "carrier_detail_code", + "status_code", + "status_description", + "carrier_status_code", + "carrier_status_description" + ], + "title": "track_event", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "exception_description": { + "description": "Exception description", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "DE" + }, + "status_description": { + "description": "Status description", + "example": "Delivered", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "DELIVERED" + }, + "status_detail_description": { + "description": "Status detail description", + "example": "Your parcel has been successfully delivered.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ] + }, + "tracking_url": { + "description": "Carrier Tracking Url, if available", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "readOnly": true, + "type": "string" + } + }, + "title": "tracking_information", + "type": "object" + } + ], + "description": "A get tracking log from label response body", + "required": [ + "tracking_number", + "status_code", + "carrier_status_code", + "events" + ], + "title": "get_tracking_log_from_label_response_body", + "type": "object" + }, + "get_tracking_log_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A tracking information resource", + "properties": { + "actual_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "estimated_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "events": { + "description": "The events that have occured during the lifetime of this tracking number.", + "items": { + "additionalProperties": false, + "description": "A track event", + "properties": { + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Carrier timestamp for the event, it is assumed to be the local time of where the event occurred." + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "city_locality": { + "description": "City locality", + "example": "AUSTIN", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "company_name": { + "description": "Company Name", + "example": "Stamps.com", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "description": { + "description": "Event description", + "example": "Delivered, In/At Mailbox", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "event_code": { + "description": "Event Code", + "minLength": 0, + "type": "string" + }, + "latitude": { + "description": "Latitude coordinate of tracking event.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "description": "Longitude coordinate of tracking event.", + "format": "double", + "maximum": 180, + "minimum": -180, + "type": "number" + }, + "occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Timestamp for carrier event" + }, + "postal_code": { + "description": "Postal code", + "example": 78756, + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "proof_of_delivery_url": { + "description": "A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.", + "example": "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png", + "readOnly": true, + "type": "string" + }, + "signer": { + "description": "Signer information", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "state_province": { + "description": "State province", + "example": "TX", + "minLength": 2, + "readOnly": true, + "type": "string" + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "IT" + }, + "status_description": { + "description": "Event Status Description", + "example": "In Transit", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "IN_TRANSIT" + }, + "status_detail_description": { + "description": "Event Status Detail Description", + "example": "Your shipment is on its way between the carrier hubs.", + "minLength": 0, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "occurred_at", + "city_locality", + "state_province", + "postal_code", + "carrier_detail_code", + "status_code", + "status_description", + "carrier_status_code", + "carrier_status_description" + ], + "title": "track_event", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "exception_description": { + "description": "Exception description", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "DE" + }, + "status_description": { + "description": "Status description", + "example": "Delivered", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "DELIVERED" + }, + "status_detail_description": { + "description": "Status detail description", + "example": "Your parcel has been successfully delivered.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ] + }, + "tracking_url": { + "description": "Carrier Tracking Url, if available", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "readOnly": true, + "type": "string" + } + }, + "title": "tracking_information", + "type": "object" + } + ], + "description": "A get tracking log response body", + "required": [ + "tracking_number", + "tracking_url", + "status_code", + "carrier_code", + "carrier_id", + "carrier_detail_code", + "carrier_status_code", + "events" + ], + "title": "get_tracking_log_response_body", + "type": "object" + }, + "get_warehouse_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "A get warehouse by id response body", + "required": [ + "warehouse_id", + "name", + "created_at", + "origin_address", + "return_address" + ], + "title": "get_warehouse_by_id_response_body", + "type": "object" + }, + "get_webhook_by_id_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A webhook", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + }, + "webhook_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the webhook", + "readOnly": true + } + }, + "title": "webhook", + "type": "object" + } + ], + "description": "A get webhook id response body", + "required": [ + "webhook_id", + "url", + "event" + ], + "title": "get_webhook_by_id_response_body", + "type": "object" + }, + "identifier_type": { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + }, + "image_id": { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + }, + "importer_of_records": { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + }, + "insurance_provider": { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + }, + "international_shipment_options": { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + }, + "invoice_additional_details": { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + }, + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "label": { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + }, + "label_charge_event": { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + }, + "label_download": { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + }, + "label_download_type": { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + }, + "label_format": { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + }, + "label_layout": { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + }, + "label_messages": { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + }, + "label_package": { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + "label_request": { + "additionalProperties": false, + "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", + "properties": { + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "required": [ + "phone", + "country_code" + ], + "title": "shipping_address_from", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + } + }, + "required": [ + "carrier_id", + "service_code", + "ship_to", + "packages" + ], + "title": "shipment_request", + "type": "object" + } + ], + "description": "The shipment information used to generate the label" + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation", + "writeOnly": true + } + }, + "title": "label_request", + "type": "object" + }, + "label_status": { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + }, + "link": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + }, + "list_account_images_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": true, + "description": "Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.\n", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ] + }, + "page": { + "description": "The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.", + "example": 1, + "minimum": 1, + "type": "integer" + }, + "pages": { + "description": "The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.", + "example": 4, + "minimum": 0, + "type": "integer" + }, + "total": { + "description": "The total number of items across all pages of results", + "example": 2750, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total", + "page", + "pages", + "links" + ], + "title": "paged_list_response_body", + "type": "object" + } + ], + "description": "A list account images response body", + "properties": { + "images": { + "description": "Image List", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "Image" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "list_account_images_response_body", + "type": "object" + }, + "list_account_settings_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account settings response body", + "properties": { + "default_label_layout": { + "allOf": [ + { + "description": "The possible default label layout values", + "enum": [ + "4x6", + "Letter" + ], + "title": "default_label_layout", + "type": "string" + } + ] + } + }, + "title": "account_settings", + "type": "object" + } + ], + "description": "An account settings list response body", + "title": "list_account_settings_body", + "type": "object" + }, + "list_account_settings_images_response_body": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": true, + "description": "Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.\n", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ] + }, + "page": { + "description": "The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.", + "example": 1, + "minimum": 1, + "type": "integer" + }, + "pages": { + "description": "The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.", + "example": 4, + "minimum": 0, + "type": "integer" + }, + "total": { + "description": "The total number of items across all pages of results", + "example": 2750, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total", + "page", + "pages", + "links" + ], + "title": "paged_list_response_body", + "type": "object" + } + ], + "description": "A list account images response body", + "properties": { + "images": { + "description": "Image List", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "Image" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "list_account_images_response_body", + "type": "object" + } + ], + "title": "list_account_settings_images_response_body" + }, + "list_batch_errors_response_body": { + "additionalProperties": false, + "description": "A batch errors response body", + "properties": { + "errors": { + "default": [], + "description": "The errors currently associated with the batch", + "items": { + "additionalProperties": false, + "description": "A batch response error", + "properties": { + "error": { + "description": "Error message associated with the shipment.", + "example": "Recipient address has not been verified.", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "An external shipment id associated with the shipment", + "readOnly": true, + "type": "string" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + } + }, + "title": "batch_response_error", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "readOnly": true + } + }, + "required": [ + "errors", + "links" + ], + "title": "list_batch_errors_response_body", + "type": "object" + }, + "list_batches_response_body": { + "additionalProperties": false, + "description": "A list batch response body", + "properties": { + "batches": { + "description": "Batch List", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "Batch" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "readOnly": true + }, + "page": { + "description": "The page that is currently being read", + "example": 1, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "description": "The total number of batch pages the API call returned", + "example": 10, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "total": { + "description": "The total number of batches the API call returned", + "example": 10, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "batches", + "total", + "page", + "pages", + "links" + ], + "title": "list_batches_response_body", + "type": "object" + }, + "list_carrier_package_types_response_body": { + "additionalProperties": false, + "description": "A list carrier package types response body", + "properties": { + "packages": { + "description": "An array of custom package types", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "Custom Package Type items", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "list_carrier_package_types_response_body", + "type": "object" + }, + "list_carrier_services_response_body": { + "additionalProperties": false, + "description": "A carrier list services response body", + "properties": { + "services": { + "description": "An array of services associated with the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "description": "A carrier service", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "list_carrier_services_response_body", + "type": "object" + }, + "list_carriers_response_body": { + "additionalProperties": false, + "description": "A carrier list response body", + "properties": { + "carriers": { + "description": "The carrier response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n", + "properties": { + "account_number": { + "description": "The account number that the carrier is connected to.", + "example": "account_570827", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "allows_returns": { + "description": "The carrier has services that support return shipments.", + "readOnly": true, + "type": "boolean" + }, + "balance": { + "description": "Current available balance", + "example": 3799.52, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier.", + "readOnly": true + }, + "connection_status": { + "description": "The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.", + "enum": [ + "pending_approval", + "approved" + ], + "readOnly": true, + "type": "string" + }, + "disabled_by_billing_plan": { + "description": "The carrier is disabled by the current ShipEngine account's billing plan.", + "readOnly": true, + "type": "boolean" + }, + "friendly_name": { + "description": "Screen readable name", + "example": "Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "funding_source_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Funding source ID for the carrier", + "nullable": true, + "readOnly": true + }, + "has_multi_package_supporting_services": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "nickname": { + "description": "Nickname given to the account when initially setting up the carrier.", + "example": "ShipEngine Account - Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "options": { + "description": "A list of options that are available to that carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "packages": { + "description": "A list of package types that are supported by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "primary": { + "description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation", + "readOnly": true, + "type": "boolean" + }, + "requires_funded_amount": { + "description": "Indicates whether the carrier requires funding to use its services", + "readOnly": true, + "type": "boolean" + }, + "send_rates": { + "description": "The carrier provides rates for the shipment.", + "readOnly": true, + "type": "boolean" + }, + "services": { + "description": "A list of services that are offered by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "supports_label_messages": { + "description": "The carrier supports adding custom label messages to an order.", + "readOnly": true, + "type": "boolean" + }, + "supports_user_managed_rates": { + "description": "The carrier supports user-managed rates for shipments.", + "readOnly": true, + "type": "boolean" + } + }, + "title": "carrier", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "carriers" + ], + "title": "list_carriers_response_body", + "type": "object" + }, + "list_labels_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": true, + "description": "Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.\n", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ] + }, + "page": { + "description": "The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.", + "example": 1, + "minimum": 1, + "type": "integer" + }, + "pages": { + "description": "The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.", + "example": 4, + "minimum": 0, + "type": "integer" + }, + "total": { + "description": "The total number of items across all pages of results", + "example": 2750, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total", + "page", + "pages", + "links" + ], + "title": "paged_list_response_body", + "type": "object" + } + ], + "description": "A list label response body", + "properties": { + "labels": { + "description": "The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`.\n", + "items": { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + }, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "labels" + ], + "title": "list_labels_response_body", + "type": "object" + }, + "list_manifests_response_body": { + "additionalProperties": false, + "description": "A list manifests response body", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "description": "Helpful links to other pages of results", + "readOnly": true + }, + "manifests": { + "default": [], + "description": "The list of available manifests", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + } + ], + "description": "A single manifest", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "page": { + "description": "Current page of the list manifests results", + "example": 3, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "description": "Total number of pages for list manifests results", + "example": 4, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "total": { + "description": "The total number of manifests returned", + "example": 3, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "manifests", + "total", + "page", + "pages", + "links" + ], + "title": "list_manifests_response_body", + "type": "object" + }, + "list_package_types_response_body": { + "additionalProperties": false, + "description": "A list package types response body", + "properties": { + "packages": { + "description": "An array of custom package types", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "Custom Package Types items", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "list_package_types_response_body", + "type": "object" + }, + "list_pickup_response_body": { + "additionalProperties": false, + "description": "A list pickup response body", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "description": "Helpful links to other pages of results", + "readOnly": true + }, + "page": { + "description": "Current page of the list pickups results", + "example": 3, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "description": "Total number of pages for list pickups results", + "example": 4, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pickups": { + "description": "An array of pickups associated with the user's account.", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ] + }, + "type": "array" + }, + "total": { + "description": "The total number of pickups returned", + "example": 3, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "pickups", + "total", + "page", + "pages", + "links" + ], + "title": "list_pickup_response_body", + "type": "object" + }, + "list_service_points_response_body": { + "description": "A list service points response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.842608, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 0.032875, + "format": "double", + "type": "number" + }, + "service_points": { + "items": { + "properties": { + "address_line1": { + "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.", + "example": "PLACE DU CANADA", + "type": "string" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "TRUN", + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.", + "example": "My fancy company name", + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "distance_in_meters": { + "description": "Distance in meters", + "example": 728.9959308847579, + "format": "double", + "type": "number" + }, + "features": { + "description": "Service features", + "items": { + "enum": [ + "drop_off_point", + "pickup_point", + "print_services", + "after_hours_locker", + "after_hours_dropbox" + ], + "type": "string" + }, + "type": "array" + }, + "hours_of_operation": { + "description": "Hours of operation", + "properties": { + "friday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "monday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "saturday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "sunday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "thursday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tuesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "wednesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.842608, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 0.032875, + "format": "double", + "type": "number" + }, + "phone_number": { + "description": "Phone number associated", + "example": "555-555-5555", + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "service_codes": { + "items": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) service code.", + "example": "chronoclassic", + "type": "string" + }, + "type": "array" + }, + "service_point_id": { + "description": "A unique identifier for a carrier drop off point.", + "example": "614940", + "type": "string" + }, + "state_province": { + "description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.", + "example": "TRUN", + "type": "string" + }, + "type": { + "default": "pudo", + "description": "Service point type", + "enum": [ + "pudo", + "locker" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "title": "list_service_points_response_body", + "type": "object" + }, + "list_shipment_rates_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A rates information resource", + "properties": { + "created_at": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "When the rate was created", + "format": "date-time", + "type": "string" + }, + "errors": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "type": "array" + }, + "invalid_rates": { + "default": [], + "description": "An array of invalid shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "Invalid Shipment Rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "rates": { + "description": "An array of shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + }, + { + "properties": { + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "description": "Shipment Rates", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "title": "rates_information", + "type": "object" + } + ], + "description": "A list shipment rates response body", + "required": [ + "rates", + "invalid_rates", + "rate_request_id", + "shipment_id", + "created_at", + "status", + "errors" + ], + "title": "list_shipment_rates_response_body", + "type": "object" + }, + "list_shipments_response_body": { + "additionalProperties": false, + "description": "A list shipment response body", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "readOnly": true + }, + "page": { + "example": "????", + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "shipments": { + "description": "The list of shipments returned by the api call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "A shipment object", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "total": { + "description": "Total number of shipments returned by the api call", + "example": 1990, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "shipments", + "total", + "page", + "pages", + "links" + ], + "title": "list_shipments_response_body", + "type": "object" + }, + "list_tags_response_body": { + "additionalProperties": false, + "description": "Response body from a successful GET /tags API call", + "properties": { + "tags": { + "description": "The array of tags returned by the API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "type": "array" + } + }, + "title": "list_tags_response_body", + "type": "object" + }, + "list_warehouses_response_body": { + "additionalProperties": false, + "description": "A warehouse list response body", + "properties": { + "warehouses": { + "description": "The array of warehouses returned by the API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "warehouses" + ], + "title": "list_warehouses_response_body", + "type": "object" + }, + "list_webhooks_response_body": { + "description": "A webhook list response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A webhook", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + }, + "webhook_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the webhook", + "readOnly": true + } + }, + "title": "webhook", + "type": "object" + } + ], + "description": "The webhook list response body" + }, + "title": "list_webhooks_response_body", + "type": "array" + }, + "manifest": { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + }, + "manifest_download": { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + }, + "manifest_request": { + "additionalProperties": false, + "description": "A reference to the manifest request", + "properties": { + "manifest_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies a manifest request", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible statuses of a manifest request", + "enum": [ + "in_progress", + "completed" + ], + "title": "manifest_request_status", + "type": "string" + } + ] + } + }, + "title": "manifest_request", + "type": "object" + }, + "manifest_request_status": { + "description": "The possible statuses of a manifest request", + "enum": [ + "in_progress", + "completed" + ], + "title": "manifest_request_status", + "type": "string" + }, + "manifests": { + "additionalProperties": false, + "description": "An array of manifest resources", + "properties": { + "manifests": { + "description": "Resulting Manifests", + "items": { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests", + "type": "object" + }, + "manifests_requests": { + "additionalProperties": false, + "description": "An array of manifest requests", + "properties": { + "manifest_requests": { + "description": "Resulting manifest requests with statuses", + "items": { + "additionalProperties": false, + "description": "A reference to the manifest request", + "properties": { + "manifest_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies a manifest request", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible statuses of a manifest request", + "enum": [ + "in_progress", + "completed" + ], + "title": "manifest_request_status", + "type": "string" + } + ] + } + }, + "title": "manifest_request", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests_requests", + "type": "object" + }, + "modify_batch": { + "additionalProperties": false, + "description": "A modify batch object", + "properties": { + "rate_ids": { + "description": "Array of Rate IDs to be modifed on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Rate ID to be modified on the batch" + }, + "type": "array" + }, + "shipment_ids": { + "description": "The Shipment Ids to be modified on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Shipment ID to be modified on the batch" + }, + "type": "array" + } + }, + "title": "modify_batch", + "type": "object" + }, + "monetary_value": { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + }, + "non_delivery": { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + }, + "normalized_entity": { + "additionalProperties": true, + "description": "The normalized value of the entity.\n\nMost entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".\n\nSome entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.\n", + "properties": {}, + "title": "normalized_entity", + "type": "object" + }, + "optional_link": { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + }, + "order_source_name": { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + }, + "origin_type": { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + }, + "package": { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + }, + "package_code": { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + }, + "package_contents": { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + }, + "package_type": { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "paged_list_response_body": { + "additionalProperties": true, + "description": "Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.\n", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ] + }, + "page": { + "description": "The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.", + "example": 1, + "minimum": 1, + "type": "integer" + }, + "pages": { + "description": "The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.", + "example": 4, + "minimum": 0, + "type": "integer" + }, + "total": { + "description": "The total number of items across all pages of results", + "example": 2750, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total", + "page", + "pages", + "links" + ], + "title": "paged_list_response_body", + "type": "object" + }, + "pagination_link": { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + }, + "paperless_download": { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + }, + "parse_address_request_body": { + "additionalProperties": false, + "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", + "properties": { + "address": { + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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" + }, + "text": { + "description": "The unstructured text that contains address-related entities", + "example": "Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "text" + ], + "title": "parse_address_request_body", + "type": "object" + }, + "parse_address_response_body": { + "additionalProperties": false, + "description": "The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.\n", + "properties": { + "address": { + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "description": "The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.\n\n> **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct.\n" + }, + "entities": { + "description": "All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value.\n", + "items": { + "additionalProperties": false, + "description": "An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value.\n", + "properties": { + "end_index": { + "description": "The index of the last character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "result": { + "additionalProperties": true, + "description": "The normalized value of the entity.\n\nMost entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".\n\nSome entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.\n", + "properties": {}, + "title": "normalized_entity", + "type": "object" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "start_index": { + "description": "The index of the first character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "text": { + "description": "The substring from the original text that was recognized as this entity", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type", + "score", + "text", + "start_index", + "end_index" + ], + "title": "recognized_entity", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it understood the text.\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "score", + "address", + "entities" + ], + "title": "parse_address_response_body", + "type": "object" + }, + "parse_shipment_request_body": { + "additionalProperties": false, + "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", + "properties": { + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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" + }, + "text": { + "description": "The unstructured text that contains shipping-related entities", + "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", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "text" + ], + "title": "parse_shipment_request_body", + "type": "object" + }, + "parse_shipment_response_body": { + "additionalProperties": false, + "description": "The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.\n", + "properties": { + "entities": { + "description": "All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value.\n", + "items": { + "additionalProperties": false, + "description": "An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value.\n", + "properties": { + "end_index": { + "description": "The index of the last character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "result": { + "additionalProperties": true, + "description": "The normalized value of the entity.\n\nMost entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".\n\nSome entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.\n", + "properties": {}, + "title": "normalized_entity", + "type": "object" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "start_index": { + "description": "The index of the first character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "text": { + "description": "The substring from the original text that was recognized as this entity", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type", + "score", + "text", + "start_index", + "end_index" + ], + "title": "recognized_entity", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it understood the text.\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.\n\n> **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct.\n" + } + }, + "required": [ + "score", + "shipment", + "entities" + ], + "title": "parse_shipment_response_body", + "type": "object" + }, + "partial_address": { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + }, + "partial_shipment": { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + "partial_shipment_for_rate_shopper": { + "additionalProperties": false, + "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", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment_for_rate_shopper", + "type": "object" + }, + "partial_shipping_address": { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + }, + "partial_shipping_address_to": { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + }, + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "pickup": { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + }, + "pickup_resource_id": { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + }, + "pickup_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ], + "description": "A pickup response body", + "required": [ + "pickup", + "pickup_id", + "label_ids", + "created_at", + "carrier_id", + "warehouse_id", + "pickup_address", + "contact_details", + "notes", + "pickup_window", + "confirmation_number" + ], + "title": "pickup_response_body", + "type": "object" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + }, + "postal_code": { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + }, + "process_batch_request_body": { + "additionalProperties": false, + "description": "A process batch request body", + "properties": { + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The Ship date the batch is being processed for" + } + }, + "title": "process_batch_request_body", + "type": "object" + }, + "products": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "purchase_label_without_shipment": { + "additionalProperties": false, + "description": "A purchase label without shipment resource", + "properties": { + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url" + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ] + } + }, + "title": "purchase_label_without_shipment", + "type": "object" + }, + "rate": { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + }, + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + }, + "rate_detail": { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + }, + "rate_detail_attributes": { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + }, + "rate_detail_type": { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + }, + "rate_estimate": { + "additionalProperties": false, + "description": "A rate estimate", + "properties": { + "carrier_code": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate_estimate", + "type": "object" + }, + "rate_estimate_by_carrier_id": { + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the carrier" + } + }, + "title": "rate_estimate_by_carrier_id", + "type": "object" + }, + "rate_estimate_by_carrier_ids": { + "properties": { + "carrier_ids": { + "description": "Array of Carrier Ids", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier id", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "title": "rate_estimate_by_carrier_ids", + "type": "object" + }, + "rate_estimate_options": { + "properties": { + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ] + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ] + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The dimensions of the package" + }, + "from_city_locality": { + "description": "from postal code", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "from_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "from_postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "from_state_province": { + "description": "From state province", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "ship date", + "type": "string" + }, + "to_city_locality": { + "description": "The city locality the package is being shipped to", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "to_postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "to_state_province": { + "description": "To state province", + "example": "Houston", + "minLength": 1, + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the package" + } + }, + "title": "rate_estimate_options", + "type": "object" + }, + "rate_request_body": { + "additionalProperties": false, + "description": "A rate request body", + "properties": { + "calculate_tax_amount": { + "description": "Calculate the duties and tariffs for cross border shipments.", + "type": "boolean" + }, + "carrier_ids": { + "description": "Array of carrier ids to get rates for", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier ids" + }, + "minItems": 1, + "type": "array" + }, + "is_return": { + "description": "Indicate if it's a return shipment", + "type": "boolean" + }, + "package_types": { + "items": { + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "preferred_currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + }, + "rate_type": { + "description": "Indicates what type of rating to perform", + "enum": [ + "check", + "shipment", + "quick" + ], + "type": "string" + }, + "service_codes": { + "items": { + "description": "Item Service Codes", + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "carrier_ids" + ], + "title": "rate_request_body", + "type": "object" + }, + "rate_request_by_shipment_ids": { + "properties": { + "shipment_ids": { + "description": "The array of shipment IDs", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "shipment ids" + }, + "type": "array" + } + }, + "required": [ + "shipment_ids" + ], + "title": "rate_request_by_shipment_ids", + "type": "object" + }, + "rate_request_by_shipments": { + "properties": { + "shipments": { + "description": "The array of shipments to get bulk rate estimates for", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ], + "description": "The shipment to get a bulk rate estimate for" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "shipments" + ], + "title": "rate_request_by_shipments", + "type": "object" + }, + "rate_request_options": { + "properties": { + "rate_options": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate request body", + "properties": { + "calculate_tax_amount": { + "description": "Calculate the duties and tariffs for cross border shipments.", + "type": "boolean" + }, + "carrier_ids": { + "description": "Array of carrier ids to get rates for", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier ids" + }, + "minItems": 1, + "type": "array" + }, + "is_return": { + "description": "Indicate if it's a return shipment", + "type": "boolean" + }, + "package_types": { + "items": { + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "preferred_currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + }, + "rate_type": { + "description": "Indicates what type of rating to perform", + "enum": [ + "check", + "shipment", + "quick" + ], + "type": "string" + }, + "service_codes": { + "items": { + "description": "Item Service Codes", + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "carrier_ids" + ], + "title": "rate_request_body", + "type": "object" + } + ], + "description": "The rate options" + } + }, + "title": "rate_request_options", + "type": "object" + }, + "rate_request_rate_options": { + "properties": { + "rate_options": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate request body", + "properties": { + "calculate_tax_amount": { + "description": "Calculate the duties and tariffs for cross border shipments.", + "type": "boolean" + }, + "carrier_ids": { + "description": "Array of carrier ids to get rates for", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier ids" + }, + "minItems": 1, + "type": "array" + }, + "is_return": { + "description": "Indicate if it's a return shipment", + "type": "boolean" + }, + "package_types": { + "items": { + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "preferred_currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + }, + "rate_type": { + "description": "Indicates what type of rating to perform", + "enum": [ + "check", + "shipment", + "quick" + ], + "type": "string" + }, + "service_codes": { + "items": { + "description": "Item Service Codes", + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "carrier_ids" + ], + "title": "rate_request_body", + "type": "object" + } + ], + "description": "The rate options" + } + }, + "title": "rate_request_rate_options", + "type": "object" + }, + "rate_response": { + "additionalProperties": false, + "properties": { + "rate_response": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rates information resource", + "properties": { + "created_at": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "When the rate was created", + "format": "date-time", + "type": "string" + }, + "errors": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "type": "array" + }, + "invalid_rates": { + "default": [], + "description": "An array of invalid shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "Invalid Shipment Rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "rates": { + "description": "An array of shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + }, + { + "properties": { + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "description": "Shipment Rates", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "title": "rates_information", + "type": "object" + } + ], + "description": "The rates response" + } + }, + "title": "rate_response", + "type": "object" + }, + "rate_response_status": { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + }, + "rate_shipment_request": { + "properties": { + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ], + "description": "The shipment object" + } + }, + "title": "rate_shipment_request", + "type": "object" + }, + "rate_type": { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + }, + "rates_information": { + "additionalProperties": false, + "description": "A rates information resource", + "properties": { + "created_at": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "When the rate was created", + "format": "date-time", + "type": "string" + }, + "errors": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "type": "array" + }, + "invalid_rates": { + "default": [], + "description": "An array of invalid shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "Invalid Shipment Rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "rates": { + "description": "An array of shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + }, + { + "properties": { + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "description": "Shipment Rates", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "title": "rates_information", + "type": "object" + }, + "reason_code": { + "description": "The possible normalized reasons a label void request may not have been approved", + "enum": [ + "unknown", + "unspecified", + "validation_failed", + "label_not_found_within_void_period", + "label_already_used", + "label_already_voided", + "contact_carrier" + ], + "title": "reason_code", + "type": "string" + }, + "recognized_entity": { + "additionalProperties": false, + "description": "An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value.\n", + "properties": { + "end_index": { + "description": "The index of the last character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "result": { + "additionalProperties": true, + "description": "The normalized value of the entity.\n\nMost entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".\n\nSome entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.\n", + "properties": {}, + "title": "normalized_entity", + "type": "object" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "start_index": { + "description": "The index of the first character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "text": { + "description": "The substring from the original text that was recognized as this entity", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type", + "score", + "text", + "start_index", + "end_index" + ], + "title": "recognized_entity", + "type": "object" + }, + "redirect": { + "description": "The resource to return a redirect URL to.", + "enum": [ + "shipengine-dashboard" + ], + "title": "redirect", + "type": "string" + }, + "refund_details": { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + }, + "refund_status": { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + }, + "regulated_content_type": { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "remove_from_batch_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A modify batch object", + "properties": { + "rate_ids": { + "description": "Array of Rate IDs to be modifed on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Rate ID to be modified on the batch" + }, + "type": "array" + }, + "shipment_ids": { + "description": "The Shipment Ids to be modified on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Shipment ID to be modified on the batch" + }, + "type": "array" + } + }, + "title": "modify_batch", + "type": "object" + } + ], + "description": "A modify batch request body", + "title": "remove_from_batch_request_body", + "type": "object" + }, + "response_message": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "schedule_pickup_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ], + "description": "A schedule pickup request body", + "required": [ + "contact_details", + "label_ids", + "pickup_window" + ], + "title": "schedule_pickup_request_body", + "type": "object" + }, + "schedule_pickup_response_body": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "schedule_pickup_response_body" + }, + "se_id": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + }, + "service": { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + }, + "service_code": { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + }, + "shipment": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + }, + "shipment_id_request": { + "properties": { + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment" + } + }, + "title": "shipment_id_request", + "type": "object" + }, + "shipment_item": { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + }, + "shipment_request": { + "additionalProperties": false, + "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", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "required": [ + "phone", + "country_code" + ], + "title": "shipping_address_from", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + } + }, + "required": [ + "carrier_id", + "service_code", + "ship_to", + "packages" + ], + "title": "shipment_request", + "type": "object" + }, + "shipment_status": { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + }, + "shipments_sort_by": { + "description": "The possible shipments sort by values", + "enum": [ + "modified_at", + "created_at" + ], + "title": "shipments_sort_by", + "type": "string" + }, + "shipping_address": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + }, + "shipping_address_from": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "required": [ + "phone", + "country_code" + ], + "title": "shipping_address_from", + "type": "object" + }, + "shipping_address_to": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + }, + "smart_post_hub": { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + }, + "sort_dir": { + "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", + "enum": [ + "asc", + "desc" + ], + "title": "sort_dir", + "type": "string" + }, + "status_code": { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + }, + "status_detail_code": { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + }, + "tag": { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + }, + "tag_name": { + "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", + "example": "Fragile", + "minLength": 1, + "title": "tag_name", + "type": "string" + }, + "tag_shipment_response_body": { + "additionalProperties": false, + "description": "Get shipment tags response body", + "properties": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tags" + ], + "title": "tag_shipment_response_body", + "type": "object" + }, + "tax_identifier": { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + }, + "tax_type": { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + }, + "taxable_entity_type": { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + }, + "tokens_get_ephemeral_token_response_body.yaml": { + "properties": { + "redirect_url": { + "description": "The redirect url formatted with the requested token.", + "type": "string" + }, + "token": { + "description": "The requested token that expires in 10 seconds.", + "type": "string" + } + }, + "title": "tokens_get_ephemeral_token_response_body.yaml", + "type": "object" + }, + "track_event": { + "additionalProperties": false, + "description": "A track event", + "properties": { + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Carrier timestamp for the event, it is assumed to be the local time of where the event occurred." + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "city_locality": { + "description": "City locality", + "example": "AUSTIN", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "company_name": { + "description": "Company Name", + "example": "Stamps.com", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "description": { + "description": "Event description", + "example": "Delivered, In/At Mailbox", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "event_code": { + "description": "Event Code", + "minLength": 0, + "type": "string" + }, + "latitude": { + "description": "Latitude coordinate of tracking event.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "description": "Longitude coordinate of tracking event.", + "format": "double", + "maximum": 180, + "minimum": -180, + "type": "number" + }, + "occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Timestamp for carrier event" + }, + "postal_code": { + "description": "Postal code", + "example": 78756, + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "proof_of_delivery_url": { + "description": "A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.", + "example": "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png", + "readOnly": true, + "type": "string" + }, + "signer": { + "description": "Signer information", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "state_province": { + "description": "State province", + "example": "TX", + "minLength": 2, + "readOnly": true, + "type": "string" + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "IT" + }, + "status_description": { + "description": "Event Status Description", + "example": "In Transit", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "IN_TRANSIT" + }, + "status_detail_description": { + "description": "Event Status Detail Description", + "example": "Your shipment is on its way between the carrier hubs.", + "minLength": 0, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "occurred_at", + "city_locality", + "state_province", + "postal_code", + "carrier_detail_code", + "status_code", + "status_description", + "carrier_status_code", + "carrier_status_description" + ], + "title": "track_event", + "type": "object" + }, + "tracking_information": { + "additionalProperties": false, + "description": "A tracking information resource", + "properties": { + "actual_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "estimated_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "events": { + "description": "The events that have occured during the lifetime of this tracking number.", + "items": { + "additionalProperties": false, + "description": "A track event", + "properties": { + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Carrier timestamp for the event, it is assumed to be the local time of where the event occurred." + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "city_locality": { + "description": "City locality", + "example": "AUSTIN", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "company_name": { + "description": "Company Name", + "example": "Stamps.com", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "description": { + "description": "Event description", + "example": "Delivered, In/At Mailbox", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "event_code": { + "description": "Event Code", + "minLength": 0, + "type": "string" + }, + "latitude": { + "description": "Latitude coordinate of tracking event.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "description": "Longitude coordinate of tracking event.", + "format": "double", + "maximum": 180, + "minimum": -180, + "type": "number" + }, + "occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Timestamp for carrier event" + }, + "postal_code": { + "description": "Postal code", + "example": 78756, + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "proof_of_delivery_url": { + "description": "A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.", + "example": "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png", + "readOnly": true, + "type": "string" + }, + "signer": { + "description": "Signer information", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "state_province": { + "description": "State province", + "example": "TX", + "minLength": 2, + "readOnly": true, + "type": "string" + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "IT" + }, + "status_description": { + "description": "Event Status Description", + "example": "In Transit", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "IN_TRANSIT" + }, + "status_detail_description": { + "description": "Event Status Detail Description", + "example": "Your shipment is on its way between the carrier hubs.", + "minLength": 0, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "occurred_at", + "city_locality", + "state_province", + "postal_code", + "carrier_detail_code", + "status_code", + "status_description", + "carrier_status_code", + "carrier_status_description" + ], + "title": "track_event", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "exception_description": { + "description": "Exception description", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "DE" + }, + "status_description": { + "description": "Status description", + "example": "Delivered", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "DELIVERED" + }, + "status_detail_description": { + "description": "Status detail description", + "example": "Your parcel has been successfully delivered.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ] + }, + "tracking_url": { + "description": "Carrier Tracking Url, if available", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "readOnly": true, + "type": "string" + } + }, + "title": "tracking_information", + "type": "object" + }, + "tracking_number": { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + }, + "tracking_status": { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "update_account_settings_image_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "A ShipEngine account settings images request body", + "required": [ + "is_default" + ], + "title": "update_account_settings_image_request_body", + "type": "object" + }, + "update_amazon_buy_shipping_request_body": { + "additionalProperties": false, + "description": "An amazon buy shipping account settings request body", + "properties": { + "email": { + "description": "Email", + "minLength": 1, + "type": "string" + } + }, + "title": "update_amazon_buy_shipping_request_body", + "type": "object" + }, + "update_carrier_settings_request_body": { + "oneOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A DHL Express account settings", + "properties": { + "is_primary_account": { + "description": "Indicates if this is primary account", + "type": "boolean" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "should_hide_account_number_on_archive_doc": { + "description": "Indicates if the account number should be hidden on the archive documentation", + "type": "boolean" + } + }, + "title": "dhl_express_account_settings", + "type": "object" + } + ], + "description": "An update dhl express settings request body", + "title": "update_dhl_express_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + } + ], + "description": "An update Fedex settings request body", + "title": "update_fedex_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A newgistics account settings request body", + "properties": { + "include_barcode_with_order_number": { + "type": "boolean" + }, + "receive_email_on_manifest_processing": { + "type": "boolean" + } + }, + "title": "update_newgistics_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "UPS account settings", + "properties": { + "account_postal_code": { + "description": "account postal code", + "minLength": 5, + "type": "string" + }, + "invoice": { + "allOf": [ + { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + } + ], + "description": "The invoice" + }, + "is_primary_account": { + "description": "Indicates if this is the primary UPS account", + "type": "boolean" + }, + "mail_innovations_cost_center": { + "description": "mail innovations cost center", + "minLength": 0, + "type": "string" + }, + "mail_innovations_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "nickname": { + "description": "nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + } + ] + }, + "use_carbon_neutral_shipping_program": { + "description": "The use carbon neutral shipping program", + "type": "boolean" + }, + "use_consolidation_services": { + "description": "The use consolidation services", + "type": "boolean" + }, + "use_ground_freight_pricing": { + "description": "The use ground freight pricing", + "type": "boolean" + }, + "use_negotiated_rates": { + "description": "The use negotiated rates", + "type": "boolean" + }, + "use_order_number_on_mail_innovations_labels": { + "description": "The use order number on mail innovations labels", + "type": "boolean" + } + }, + "title": "ups_account_settings", + "type": "object" + } + ], + "description": "An update UPS settings request body", + "title": "update_ups_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An amazon buy shipping account settings request body", + "properties": { + "email": { + "description": "Email", + "minLength": 1, + "type": "string" + } + }, + "title": "update_amazon_buy_shipping_request_body", + "type": "object" + } + ], + "title": "update_carrier_settings_request_body" + }, + "update_dhl_express_settings_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A DHL Express account settings", + "properties": { + "is_primary_account": { + "description": "Indicates if this is primary account", + "type": "boolean" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "should_hide_account_number_on_archive_doc": { + "description": "Indicates if the account number should be hidden on the archive documentation", + "type": "boolean" + } + }, + "title": "dhl_express_account_settings", + "type": "object" + } + ], + "description": "An update dhl express settings request body", + "title": "update_dhl_express_settings_request_body", + "type": "object" + }, + "update_fedex_settings_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + } + ], + "description": "An update Fedex settings request body", + "title": "update_fedex_settings_request_body", + "type": "object" + }, + "update_newgistics_settings_request_body": { + "additionalProperties": false, + "description": "A newgistics account settings request body", + "properties": { + "include_barcode_with_order_number": { + "type": "boolean" + }, + "receive_email_on_manifest_processing": { + "type": "boolean" + } + }, + "title": "update_newgistics_settings_request_body", + "type": "object" + }, + "update_package_type_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "An update package type request body", + "title": "update_package_type_request_body", + "type": "object" + }, + "update_shipment_fields": { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "update_shipment_fields", + "type": "object" + }, + "update_shipment_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "update_shipment_fields", + "type": "object" + } + ], + "description": "An update shipment request body", + "required": [ + "ship_to", + "ship_from" + ], + "title": "update_shipment_request_body", + "type": "object" + }, + "update_shipment_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "properties": { + "address_validation": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation" + }, + "errors": { + "deprecated": true, + "description": "An array of errors that occurred while creating shipment.", + "items": { + "description": "An error that occurred while creating a shipment.", + "example": "Parameter value '100000000.00' is out of range.", + "minLength": 1, + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "title": "create_shipment_response_body_fields", + "type": "object" + } + ], + "description": "A create and validate shipment resource", + "title": "create_and_validate_shipment", + "type": "object" + } + ], + "description": "An update shipment response body", + "required": [ + "errors", + "has_errors", + "address_validation", + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "shipment_status", + "ship_to", + "ship_from", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "update_shipment_response_body", + "type": "object" + }, + "update_shipments_tags": { + "example": { + "shipments_tags": [ + { + "shipment_id": "se-1014296", + "tags": [ + "Fragile", + "International" + ] + }, + { + "shipment_id": "se-1014297", + "tags": [ + "Fragile", + "International" + ] + } + ] + }, + "properties": { + "shipments_tags": { + "items": { + "properties": { + "shipment_id": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "title": "update_shipments_tags", + "type": "object" + }, + "update_shipments_tags_request_body": { + "allOf": [ + { + "example": { + "shipments_tags": [ + { + "shipment_id": "se-1014296", + "tags": [ + "Fragile", + "International" + ] + }, + { + "shipment_id": "se-1014297", + "tags": [ + "Fragile", + "International" + ] + } + ] + }, + "properties": { + "shipments_tags": { + "items": { + "properties": { + "shipment_id": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "title": "update_shipments_tags", + "type": "object" + } + ], + "description": "A request body with shipments and tags", + "title": "update_shipments_tags_request_body", + "type": "object" + }, + "update_ups_settings_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "UPS account settings", + "properties": { + "account_postal_code": { + "description": "account postal code", + "minLength": 5, + "type": "string" + }, + "invoice": { + "allOf": [ + { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + } + ], + "description": "The invoice" + }, + "is_primary_account": { + "description": "Indicates if this is the primary UPS account", + "type": "boolean" + }, + "mail_innovations_cost_center": { + "description": "mail innovations cost center", + "minLength": 0, + "type": "string" + }, + "mail_innovations_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "nickname": { + "description": "nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + } + ] + }, + "use_carbon_neutral_shipping_program": { + "description": "The use carbon neutral shipping program", + "type": "boolean" + }, + "use_consolidation_services": { + "description": "The use consolidation services", + "type": "boolean" + }, + "use_ground_freight_pricing": { + "description": "The use ground freight pricing", + "type": "boolean" + }, + "use_negotiated_rates": { + "description": "The use negotiated rates", + "type": "boolean" + }, + "use_order_number_on_mail_innovations_labels": { + "description": "The use order number on mail innovations labels", + "type": "boolean" + } + }, + "title": "ups_account_settings", + "type": "object" + } + ], + "description": "An update UPS settings request body", + "title": "update_ups_settings_request_body", + "type": "object" + }, + "update_warehouse_request_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "An update warehouse request body", + "required": [ + "name", + "origin_address" + ], + "title": "update_warehouse_request_body", + "type": "object" + }, + "update_warehouse_settings_request_body": { + "additionalProperties": false, + "description": "An update warehouse settings request body", + "properties": { + "is_default": { + "description": "The default property on the warehouse.", + "example": true, + "nullable": true, + "type": "boolean" + } + }, + "title": "update_warehouse_settings_request_body", + "type": "object" + }, + "update_webhook_request_body": { + "additionalProperties": false, + "description": "An update webhook request body", + "properties": { + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Updated Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the wehbook sends the request", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + } + }, + "title": "update_webhook_request_body", + "type": "object" + }, + "ups_account_settings": { + "additionalProperties": false, + "description": "UPS account settings", + "properties": { + "account_postal_code": { + "description": "account postal code", + "minLength": 5, + "type": "string" + }, + "invoice": { + "allOf": [ + { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + } + ], + "description": "The invoice" + }, + "is_primary_account": { + "description": "Indicates if this is the primary UPS account", + "type": "boolean" + }, + "mail_innovations_cost_center": { + "description": "mail innovations cost center", + "minLength": 0, + "type": "string" + }, + "mail_innovations_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "nickname": { + "description": "nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + } + ] + }, + "use_carbon_neutral_shipping_program": { + "description": "The use carbon neutral shipping program", + "type": "boolean" + }, + "use_consolidation_services": { + "description": "The use consolidation services", + "type": "boolean" + }, + "use_ground_freight_pricing": { + "description": "The use ground freight pricing", + "type": "boolean" + }, + "use_negotiated_rates": { + "description": "The use negotiated rates", + "type": "boolean" + }, + "use_order_number_on_mail_innovations_labels": { + "description": "The use order number on mail innovations labels", + "type": "boolean" + } + }, + "title": "ups_account_settings", + "type": "object" + }, + "ups_invoice": { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + }, + "ups_pickup_type": { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + }, + "ups_settings_response_body": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "UPS account settings", + "properties": { + "account_postal_code": { + "description": "account postal code", + "minLength": 5, + "type": "string" + }, + "invoice": { + "allOf": [ + { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + } + ], + "description": "The invoice" + }, + "is_primary_account": { + "description": "Indicates if this is the primary UPS account", + "type": "boolean" + }, + "mail_innovations_cost_center": { + "description": "mail innovations cost center", + "minLength": 0, + "type": "string" + }, + "mail_innovations_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "nickname": { + "description": "nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + } + ] + }, + "use_carbon_neutral_shipping_program": { + "description": "The use carbon neutral shipping program", + "type": "boolean" + }, + "use_consolidation_services": { + "description": "The use consolidation services", + "type": "boolean" + }, + "use_ground_freight_pricing": { + "description": "The use ground freight pricing", + "type": "boolean" + }, + "use_negotiated_rates": { + "description": "The use negotiated rates", + "type": "boolean" + }, + "use_order_number_on_mail_innovations_labels": { + "description": "The use order number on mail innovations labels", + "type": "boolean" + } + }, + "title": "ups_account_settings", + "type": "object" + } + ], + "description": "A UPS settings response body", + "title": "ups_settings_response_body", + "type": "object" + }, + "url": { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + }, + "uuid": { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + }, + "validate_address": { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + }, + "validate_address_request_body": { + "description": "An address validation request body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "description": "Any residential or business mailing address, anywhere in the world.\n", + "required": [ + "address_line1", + "city_locality", + "state_province", + "country_code" + ], + "title": "address_to_validate", + "type": "object" + } + ], + "description": "An array of addresses to validate." + }, + "title": "validate_address_request_body", + "type": "array" + }, + "validate_address_response_body": { + "description": "An address validation response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation response body", + "readOnly": true + }, + "title": "validate_address_response_body", + "type": "array" + }, + "validate_shipment_fields": { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + "validation_status": { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + }, + "void_label_response_body": { + "additionalProperties": false, + "description": "A void label response body", + "properties": { + "approved": { + "description": "Indicates whether the attempt to void the label was successful", + "example": false, + "readOnly": true, + "type": "boolean" + }, + "message": { + "example": "Unable to delete FedEx shipment. Unable to retrieve record from database.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "reason_code": { + "allOf": [ + { + "description": "The possible normalized reasons a label void request may not have been approved", + "enum": [ + "unknown", + "unspecified", + "validation_failed", + "label_not_found_within_void_period", + "label_already_used", + "label_already_voided", + "contact_carrier" + ], + "title": "reason_code", + "type": "string" + } + ], + "description": "Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. \u201cunknown\u201d codes may be specified later.", + "example": "label_not_found_within_void_period", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "approved", + "message" + ], + "title": "void_label_response_body", + "type": "object" + }, + "void_type": { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + }, + "warehouse": { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + }, + "webhook": { + "additionalProperties": false, + "description": "A webhook", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + }, + "webhook_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the webhook", + "readOnly": true + } + }, + "title": "webhook", + "type": "object" + }, + "webhook_event": { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + }, + "webhook_header": { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + }, + "weight": { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + }, + "weight_unit": { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + }, + "securitySchemes": { + "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/).\n", + "in": "header", + "name": "API-Key", + "type": "apiKey" + } + } + }, + "externalDocs": { + "description": "ShipEngine's documentation is designed to help you start shipping as quickly as possible. With easy-to-follow tutorials, detailed reference docs, and ready-made recipes for common use cases, you'll see real results in no time at all.\n", + "url": "https://www.shipengine.com/docs/" + }, + "info": { + "contact": { + "email": "sales@shipengine.com", + "name": "ShipEngine Sales & Support", + "url": "https://www.shipengine.com/contact/", + "x-phone": "1-512-856-5379" + }, + "description": "ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.\n\nEach of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.\n\n## Getting Started\nIf you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips.\n\nHere are some step-by-step **tutorials** to get you started:\n\n - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/)\n - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/)\n - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/)\n\n\n## Shipping Labels for Every Major Carrier\nShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/).\n\n\n## Real-Time Package Tracking\nWith ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is.\n\n\n## Compare Shipping Costs Across Carriers\nMake sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info.\n\n\n## Worldwide Address Validation\nShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.\n", + "termsOfService": "https://www.shipengine.com/terms-of-service/", + "title": "ShipEngine API", + "version": "1.1.202604070904", + "x-logo": { + "altText": "ShipEngine logo", + "backgroundColor": "#FFFFFF", + "url": "https://shipengine.github.io/img/shipengine-logo-square.png" + } + }, + "openapi": "3.0.0", + "paths": { + "/v1/account/settings": { + "description": "ShipEngine Account settings", + "get": { + "description": "List all account settings for the ShipEngine account", + "operationId": "list_account_settings", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account settings response body", + "properties": { + "default_label_layout": { + "allOf": [ + { + "description": "The possible default label layout values", + "enum": [ + "4x6", + "Letter" + ], + "title": "default_label_layout", + "type": "string" + } + ] + } + }, + "title": "account_settings", + "type": "object" + } + ], + "description": "An account settings list response body", + "title": "list_account_settings_body", + "type": "object" + } + ], + "title": "get_account_settings_response_body" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Account Settings", + "tags": [ + "account" + ] + }, + "summary": "Account settings" + }, + "/v1/account/settings/images": { + "description": "ShipEngine Account images", + "get": { + "description": "List all account images for the ShipEngine account", + "operationId": "list_account_images", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": true, + "description": "Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.\n", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ] + }, + "page": { + "description": "The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.", + "example": 1, + "minimum": 1, + "type": "integer" + }, + "pages": { + "description": "The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.", + "example": 4, + "minimum": 0, + "type": "integer" + }, + "total": { + "description": "The total number of items across all pages of results", + "example": 2750, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total", + "page", + "pages", + "links" + ], + "title": "paged_list_response_body", + "type": "object" + } + ], + "description": "A list account images response body", + "properties": { + "images": { + "description": "Image List", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "Image" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "images" + ], + "title": "list_account_images_response_body", + "type": "object" + } + ], + "title": "list_account_settings_images_response_body" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Account Images", + "tags": [ + "account" + ] + }, + "post": { + "description": "Create an Account Image", + "operationId": "create_account_image", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "A ShipEngine account settings images request body", + "required": [ + "name", + "image_content_type", + "image_data" + ], + "title": "create_account_settings_image_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "A get account images by id response body", + "title": "get_account_settings_images_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create an Account Image", + "tags": [ + "account" + ] + }, + "summary": "Account settings images" + }, + "/v1/account/settings/images/{label_image_id}": { + "delete": { + "description": "Delete Account Image By Id", + "operationId": "delete_account_image_by_id", + "parameters": [ + { + "description": "Label Image Id", + "in": "path", + "name": "label_image_id", + "required": true, + "schema": { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + } + ], + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Delete Account Image By Id", + "tags": [ + "account" + ] + }, + "description": "ShipEngine Account images", + "get": { + "description": "Retrieve information for an account image.", + "operationId": "get_account_settings_images_by_id", + "parameters": [ + { + "description": "Label Image Id", + "in": "path", + "name": "label_image_id", + "required": true, + "schema": { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "A get account images by id response body", + "title": "get_account_settings_images_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Account Image By ID", + "tags": [ + "account" + ] + }, + "put": { + "description": "Update information for an account image.", + "operationId": "update_account_settings_images_by_id", + "parameters": [ + { + "description": "Label Image Id", + "in": "path", + "name": "label_image_id", + "required": true, + "schema": { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A ShipEngine account images body", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was created in ShipEngine.", + "readOnly": true + }, + "image_content_type": { + "allOf": [ + { + "description": "The image type", + "enum": [ + "image/png", + "image/jpeg" + ], + "type": "string" + } + ], + "description": "The file type of the image. \n" + }, + "image_data": { + "description": "A base64 encoded string representation of the image.\n", + "example": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==", + "type": "string" + }, + "is_default": { + "description": "Indicates whether this image is set as default.\n", + "example": false, + "type": "boolean" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.\n", + "readOnly": true + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the image was modified in ShipEngine.", + "readOnly": true + }, + "name": { + "description": "A human readable name for the image.\n", + "example": "My logo", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "title": "account_settings_images", + "type": "object" + } + ], + "description": "A ShipEngine account settings images request body", + "required": [ + "is_default" + ], + "title": "update_account_settings_image_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Account Image By ID", + "tags": [ + "account" + ] + }, + "summary": "Account settings images" + }, + "/v1/addresses/recognize": { + "description": "Data 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 address data (e.g. recipient name, address line 1, line 2, city, postal code) from this unstructured text.\n", + "put": { + "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", + "operationId": "parse_address", + "requestBody": { + "content": { + "application/json": { + "examples": { + "some_known_fields": { + "description": "You can optionally provide an `address` object containing any 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", + "summary": "Some known fields", + "value": { + "address": { + "address_residential_indicator": "yes", + "country_code": "US" + }, + "text": "Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652." + } + }, + "text_only": { + "description": "This is the simplest way to call the address-recognition API. Just pass the text to be parsed and nothing else.\n", + "summary": "Text only", + "value": { + "text": "Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652." + } + } + }, + "schema": { + "additionalProperties": false, + "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", + "properties": { + "address": { + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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" + }, + "text": { + "description": "The unstructured text that contains address-related entities", + "example": "Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "text" + ], + "title": "parse_address_request_body", + "type": "object" + } + } + }, + "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", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "some_known_fields": { + "description": "This response is shows that the address-recognition API was able to recognize all the address entities in the text. Notice that the `country_code` and `address_residential_indicator` fields are populated with the values that were provided in the request.\n", + "value": { + "address": { + "address_line1": "3800 North Lamar", + "address_line2": "Suite 200", + "address_residential_indicator": "yes", + "city_locality": "Austin", + "country_code": "US", + "name": "Margie McMiller", + "postal_code": "78652", + "state_province": "TX" + }, + "entities": [ + { + "end_index": 14, + "result": { + "value": "Margie McMiller" + }, + "score": 0.9519646137063122, + "start_index": 0, + "text": "Margie McMiller", + "type": "person" + }, + { + "end_index": 34, + "result": { + "line": 1, + "value": "3800 North Lamar" + }, + "score": 0.9805313966503588, + "start_index": 19, + "text": "3800 North Lamar", + "type": "address_line" + }, + { + "end_index": 22, + "result": { + "type": "cardinal", + "value": 3800 + }, + "score": 0.9805313966503588, + "start_index": 19, + "text": 3800, + "type": "number" + }, + { + "end_index": 44, + "result": { + "line": 2, + "value": "Suite 200" + }, + "score": 1, + "start_index": 36, + "text": "suite 200", + "type": "address_line" + }, + { + "end_index": 44, + "result": { + "type": "cardinal", + "value": 200 + }, + "score": 0.9805313966503588, + "start_index": 42, + "text": 200, + "type": "number" + }, + { + "end_index": 54, + "result": { + "value": "Austin" + }, + "score": 0.9805313966503588, + "start_index": 49, + "text": "austin", + "type": "city_locality" + }, + { + "end_index": 58, + "result": { + "name": "Texas", + "value": "TX" + }, + "score": 0.6082904353940255, + "start_index": 57, + "text": "tx", + "type": "state_province" + }, + { + "end_index": 88, + "result": { + "value": 78652 + }, + "score": 0.9519646137063122, + "start_index": 84, + "text": 78652, + "type": "postal_code" + } + ], + "score": 0.9122137426845613 + } + }, + "text_only": { + "description": "This response shows that the address-recognition API was able to recognize all the address entities in the text. Notice that the `country_code` is not populated and the `address_residential_indicator` is \"unknown\", since neither of these fields was included in the text.\n", + "value": { + "address": { + "address_line1": "3800 North Lamar", + "address_line2": "Suite 200", + "address_residential_indicator": "unknown", + "city_locality": "Austin", + "name": "Margie McMiller", + "postal_code": "78652", + "state_province": "TX" + }, + "entities": [ + { + "end_index": 14, + "result": { + "value": "Margie McMiller" + }, + "score": 0.9519646137063122, + "start_index": 0, + "text": "Margie McMiller", + "type": "person" + }, + { + "end_index": 34, + "result": { + "line": 1, + "value": "3800 North Lamar" + }, + "score": 0.9805313966503588, + "start_index": 19, + "text": "3800 North Lamar", + "type": "address_line" + }, + { + "end_index": 22, + "result": { + "type": "cardinal", + "value": 3800 + }, + "score": 0.9805313966503588, + "start_index": 19, + "text": 3800, + "type": "number" + }, + { + "end_index": 44, + "result": { + "line": 2, + "value": "Suite 200" + }, + "score": 1, + "start_index": 36, + "text": "suite 200", + "type": "address_line" + }, + { + "end_index": 44, + "result": { + "type": "cardinal", + "value": 200 + }, + "score": 0.9805313966503588, + "start_index": 42, + "text": 200, + "type": "number" + }, + { + "end_index": 54, + "result": { + "value": "Austin" + }, + "score": 0.9805313966503588, + "start_index": 49, + "text": "austin", + "type": "city_locality" + }, + { + "end_index": 58, + "result": { + "name": "Texas", + "value": "TX" + }, + "score": 0.6082904353940255, + "start_index": 57, + "text": "tx", + "type": "state_province" + }, + { + "end_index": 88, + "result": { + "value": 78652 + }, + "score": 0.9519646137063122, + "start_index": 84, + "text": 78652, + "type": "postal_code" + } + ], + "score": 0.9122137426845613 + } + } + }, + "schema": { + "additionalProperties": false, + "description": "The parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.\n", + "properties": { + "address": { + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "description": "The parsed address. This address may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.\n\n> **Note:** The address-recognition API does not currently perform any validation of the parsed address, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the address is correct.\n" + }, + "entities": { + "description": "All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, or an address line. Each entity includes the original text and the parsed value.\n", + "items": { + "additionalProperties": false, + "description": "An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value.\n", + "properties": { + "end_index": { + "description": "The index of the last character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "result": { + "additionalProperties": true, + "description": "The normalized value of the entity.\n\nMost entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".\n\nSome entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.\n", + "properties": {}, + "title": "normalized_entity", + "type": "object" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "start_index": { + "description": "The index of the first character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "text": { + "description": "The substring from the original text that was recognized as this entity", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type", + "score", + "text", + "start_index", + "end_index" + ], + "title": "recognized_entity", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it understood the text.\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "score", + "address", + "entities" + ], + "title": "parse_address_response_body", + "type": "object" + } + } + }, + "description": "Returns the parsed address, as well as a confidence score and a list of all the entities that were recognized in the text.\n" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Parse an address", + "tags": [ + "addresses" + ] + }, + "summary": "Parse an address" + }, + "/v1/addresses/validate": { + "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", + "post": { + "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", + "operationId": "validate_address", + "requestBody": { + "content": { + "application/json": { + "examples": { + "all_known_fields_request": { + "description": "A call that returns a status of `verified`.", + "summary": "All Known Fields", + "value": [ + { + "address_line1": "500 South Buena Vista Street", + "city_locality": "Burbank", + "company_name": "The Walt Disney Company", + "country_code": "US", + "name": "Mickey and Minnie Mouse", + "phone": "714-781-4565", + "postal_code": "91521", + "state_province": "CA" + } + ] + } + }, + "schema": { + "description": "An address validation request body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "description": "Any residential or business mailing address, anywhere in the world.\n", + "required": [ + "address_line1", + "city_locality", + "state_province", + "country_code" + ], + "title": "address_to_validate", + "type": "object" + } + ], + "description": "An array of addresses to validate." + }, + "title": "validate_address_request_body", + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "all_known_fields": { + "description": "A response for a `verified` status call.", + "summary": "All Known Fields", + "value": [ + { + "matched_address": { + "address_line1": "500 S BUENA VISTA ST", + "address_line2": null, + "address_line3": null, + "address_residential_indicator": "no", + "city_locality": "BURBANK", + "company_name": "THE WALT DISNEY COMPANY", + "country_code": "US", + "name": "MICKEY AND MINNIE MOUSE", + "phone": "714-781-4565", + "postal_code": "91521-0007", + "state_province": "CA" + }, + "messages": [], + "original_address": { + "address_line1": "500 South Buena Vista Street", + "address_line2": null, + "address_line3": null, + "address_residential_indicator": "unknown", + "city_locality": "Burbank", + "company_name": "The Walt Disney Company", + "country_code": "US", + "name": "Mickey and Minnie Mouse", + "phone": "714-781-4565", + "postal_code": "91521", + "state_province": "CA" + }, + "status": "verified" + } + ] + }, + "empty_fields": { + "description": "A response for an `unverified` API Call with error message", + "summary": "Empty Fields", + "value": [ + { + "matched_address": null, + "messages": [ + { + "code": "a1001", + "detail_code": "unsupported_country", + "message": "country_code is not currently a supported country please check the documentation for acceptable 2-letter country codes.", + "type": "error" + } + ], + "original_address": { + "address_line1": null, + "address_line2": null, + "address_line3": null, + "address_residential_indicator": "unknown", + "city_locality": null, + "company_name": null, + "country_code": null, + "name": null, + "phone": null, + "postal_code": null, + "state_province": null + }, + "status": "unverified" + } + ] + } + }, + "schema": { + "description": "An address validation response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation response body", + "readOnly": true + }, + "title": "validate_address_response_body", + "type": "array" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Validate An Address", + "tags": [ + "addresses" + ] + }, + "summary": "Address Validation" + }, + "/v1/batches": { + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time.\nWhen ShipEngine generates labels it relies on many carriers, their services, their dependencies, and a number of other variables\nto fulfill your requests; those requests can take a few minutes for us to get back to you.\n", + "get": { + "description": "List Batches associated with your Shipengine account", + "operationId": "list_batches", + "parameters": [ + { + "in": "query", + "name": "status", + "required": false, + "schema": { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + }, + { + "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", + "example": 2, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 1, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "The number of results to return per response.", + "example": 50, + "in": "query", + "name": "page_size", + "required": false, + "schema": { + "default": 25, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Controls the sort order of the query.", + "in": "query", + "name": "sort_dir", + "required": false, + "schema": { + "allOf": [ + { + "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", + "enum": [ + "asc", + "desc" + ], + "title": "sort_dir", + "type": "string" + } + ], + "default": "desc" + } + }, + { + "description": "Batch Number", + "in": "query", + "name": "batch_number", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Only return batches that were created on or after a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only return batches that were created on or before a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only return batches that were processed on or after a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "processed_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only return batches that were processed on or before a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "processed_at_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "description": "The possible batches sort by values", + "enum": [ + "ship_date", + "processed_at", + "created_at" + ], + "title": "batches_sort_by", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A list batch response body", + "properties": { + "batches": { + "description": "Batch List", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "Batch" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "readOnly": true + }, + "page": { + "description": "The page that is currently being read", + "example": 1, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "description": "The total number of batch pages the API call returned", + "example": 10, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "total": { + "description": "The total number of batches the API call returned", + "example": 10, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "batches", + "total", + "page", + "pages", + "links" + ], + "title": "list_batches_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Batches", + "tags": [ + "batches" + ] + }, + "post": { + "description": "Create a Batch", + "operationId": "create_batch", + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "additionalProperties": false, + "description": "A create batch request body", + "properties": { + "batch_notes": { + "description": "Add custom messages for a particular batch", + "example": "This is my batch", + "minLength": 1, + "type": "string" + }, + "external_batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the external batch" + }, + "rate_ids": { + "description": "Array of rate IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "shipment_ids": { + "description": "Array of shipment IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_batch_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A create and process batch request body", + "properties": { + "batch_notes": { + "description": "Add custom messages for a particular batch", + "example": "This is my batch", + "minLength": 1, + "type": "string" + }, + "external_batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the external batch" + }, + "process_labels": { + "description": "The information used to process the batch", + "properties": { + "create_batch_and_process_labels": { + "description": "When 'true', the batch will be enqueued for processing", + "type": "boolean" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The Ship date the batch is being processed for" + } + }, + "type": "object" + }, + "rate_ids": { + "description": "Array of rate IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "shipment_ids": { + "description": "Array of shipment IDs used in the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_and_process_batch_request_body", + "type": "object" + } + ], + "title": "create_batch_request" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "A create batch response body", + "title": "create_batch_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "207": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "A create batch response body", + "title": "create_batch_response_body", + "type": "object" + } + } + }, + "description": "The request was a partial success. It contains results, as well as processing errors." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create A Batch", + "tags": [ + "batches" + ] + }, + "summary": "Batches" + }, + "/v1/batches/external_batch_id/{external_batch_id}": { + "description": "Retrive a batch from an external batch ID", + "get": { + "description": "Get Batch By External ID", + "operationId": "get_batch_by_external_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "A get batch by external id response body", + "title": "get_batch_by_external_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Batch By External ID", + "tags": [ + "batches" + ] + }, + "parameters": [ + { + "example": "13553d7f-3c87-4771-bae1-c49bacef11cb", + "in": "path", + "name": "external_batch_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "External Batch ID" + }, + "/v1/batches/{batch_id}": { + "delete": { + "description": "Delete Batch By Id", + "operationId": "delete_batch", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Delete Batch By Id", + "tags": [ + "batches" + ] + }, + "description": "Check the status of your batch by retrieving it with a Batch ID.", + "get": { + "description": "Get Batch By ID", + "operationId": "get_batch_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or\nthousands of labels at a time.\n", + "properties": { + "batch_errors_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch errors endpoint", + "readOnly": true + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the batch", + "readOnly": true + }, + "batch_labels_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "Link to batch labels query" + }, + "batch_notes": { + "default": "", + "description": "Custom notes you can add for each created batch", + "example": "Batch for morning shipment", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "batch_number": { + "description": "The batch number.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "batch_shipments_url": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The batch shipments endpoint" + }, + "completed": { + "description": "The number of labels generated in the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "count": { + "description": "The total of errors, warnings, and completed properties", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was created in ShipEngine", + "readOnly": true + }, + "errors": { + "description": "The number of errors that occurred while generating the batch", + "example": 2, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "external_batch_id": { + "description": "A string that uniquely identifies the external batch", + "minLength": 0, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "forms": { + "description": "The number of forms for customs that are available for download", + "example": 3, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the batch", + "readOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "readOnly": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "description": "label layout", + "readOnly": true + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "process_errors": { + "description": "The errors associated with the failed API call", + "errors": null, + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "processed_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time the batch was processed in ShipEngine", + "nullable": true, + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible batch status values", + "enum": [ + "open", + "queued", + "processing", + "completed", + "completed_with_errors", + "archived", + "notifying", + "invalid" + ], + "title": "batch_status", + "type": "string" + } + ], + "readOnly": true + }, + "warnings": { + "description": "The number of warnings that occurred while generating the batch", + "example": 1, + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "label_layout", + "label_format", + "batch_id", + "batch_number", + "external_batch_id", + "batch_notes", + "created_at", + "processed_at", + "errors", + "process_errors", + "warnings", + "completed", + "forms", + "count", + "batch_shipments_url", + "batch_labels_url", + "batch_errors_url", + "label_download", + "form_download", + "paperless_download", + "status" + ], + "title": "batch", + "type": "object" + } + ], + "description": "A get batch by id response body", + "title": "get_batch_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Batch By ID", + "tags": [ + "batches" + ] + }, + "parameters": [ + { + "description": "Batch ID", + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Update Batch By Id", + "operationId": "update_batch", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Batch By Id", + "tags": [ + "batches" + ] + }, + "summary": "Batch By ID" + }, + "/v1/batches/{batch_id}/add": { + "description": "You can check your balance for a particular carrier by calling [List Carriers](https://www.shipengine.com/docs/reference/list-carriers/) endpoint.\nFor any carrier account where requires_funded_amount is true, you can add funds.\n", + "parameters": [ + { + "description": "Batch ID", + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "post": { + "description": "Add a Shipment or Rate to a Batch", + "operationId": "add_to_batch", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A modify batch object", + "properties": { + "rate_ids": { + "description": "Array of Rate IDs to be modifed on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Rate ID to be modified on the batch" + }, + "type": "array" + }, + "shipment_ids": { + "description": "The Shipment Ids to be modified on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Shipment ID to be modified on the batch" + }, + "type": "array" + } + }, + "title": "modify_batch", + "type": "object" + } + ], + "description": "An add to batch request body", + "title": "add_to_batch_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Add to a Batch", + "tags": [ + "batches" + ] + }, + "summary": "Add Funds to a Carrier" + }, + "/v1/batches/{batch_id}/errors": { + "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", + "get": { + "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", + "operationId": "list_batch_errors", + "parameters": [ + { + "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", + "example": 2, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 1, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "in": "query", + "name": "pagesize", + "required": false, + "schema": { + "format": "int32", + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A batch errors response body", + "properties": { + "errors": { + "default": [], + "description": "The errors currently associated with the batch", + "items": { + "additionalProperties": false, + "description": "A batch response error", + "properties": { + "error": { + "description": "Error message associated with the shipment.", + "example": "Recipient address has not been verified.", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "An external shipment id associated with the shipment", + "readOnly": true, + "type": "string" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + } + }, + "title": "batch_response_error", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "readOnly": true + } + }, + "required": [ + "errors", + "links" + ], + "title": "list_batch_errors_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Batch Errors", + "tags": [ + "batches" + ] + }, + "parameters": [ + { + "description": "Batch ID", + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Batch Errors" + }, + "/v1/batches/{batch_id}/process/labels": { + "description": "Process Batch ID Labels", + "parameters": [ + { + "description": "Batch ID", + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "post": { + "description": "Process Batch ID Labels", + "operationId": "process_batch", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A process batch request body", + "properties": { + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The Ship date the batch is being processed for" + } + }, + "title": "process_batch_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Process Batch ID Labels", + "tags": [ + "batches" + ] + }, + "summary": "Process Batch ID Labels" + }, + "/v1/batches/{batch_id}/remove": { + "description": "Remove a list of shipments from a batch", + "parameters": [ + { + "description": "Batch ID", + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "post": { + "description": "Remove a shipment or rate from a batch", + "operationId": "remove_from_batch", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A modify batch object", + "properties": { + "rate_ids": { + "description": "Array of Rate IDs to be modifed on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Rate ID to be modified on the batch" + }, + "type": "array" + }, + "shipment_ids": { + "description": "The Shipment Ids to be modified on the batch", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The Shipment ID to be modified on the batch" + }, + "type": "array" + } + }, + "title": "modify_batch", + "type": "object" + } + ], + "description": "A modify batch request body", + "title": "remove_from_batch_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Remove From Batch", + "tags": [ + "batches" + ] + }, + "summary": "Remove Batch By ID" + }, + "/v1/carriers": { + "description": "Carriers are a company or individual that specializes in transporting freight from one destination to another.\nShipengine allows you to easily integrate with multiple carriers so you can chose the shipping option that is right for you.\n", + "get": { + "description": "List all carriers that have been added to this account", + "operationId": "list_carriers", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier list response body", + "properties": { + "carriers": { + "description": "The carrier response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n", + "properties": { + "account_number": { + "description": "The account number that the carrier is connected to.", + "example": "account_570827", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "allows_returns": { + "description": "The carrier has services that support return shipments.", + "readOnly": true, + "type": "boolean" + }, + "balance": { + "description": "Current available balance", + "example": 3799.52, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier.", + "readOnly": true + }, + "connection_status": { + "description": "The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.", + "enum": [ + "pending_approval", + "approved" + ], + "readOnly": true, + "type": "string" + }, + "disabled_by_billing_plan": { + "description": "The carrier is disabled by the current ShipEngine account's billing plan.", + "readOnly": true, + "type": "boolean" + }, + "friendly_name": { + "description": "Screen readable name", + "example": "Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "funding_source_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Funding source ID for the carrier", + "nullable": true, + "readOnly": true + }, + "has_multi_package_supporting_services": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "nickname": { + "description": "Nickname given to the account when initially setting up the carrier.", + "example": "ShipEngine Account - Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "options": { + "description": "A list of options that are available to that carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "packages": { + "description": "A list of package types that are supported by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "primary": { + "description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation", + "readOnly": true, + "type": "boolean" + }, + "requires_funded_amount": { + "description": "Indicates whether the carrier requires funding to use its services", + "readOnly": true, + "type": "boolean" + }, + "send_rates": { + "description": "The carrier provides rates for the shipment.", + "readOnly": true, + "type": "boolean" + }, + "services": { + "description": "A list of services that are offered by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "supports_label_messages": { + "description": "The carrier supports adding custom label messages to an order.", + "readOnly": true, + "type": "boolean" + }, + "supports_user_managed_rates": { + "description": "The carrier supports user-managed rates for shipments.", + "readOnly": true, + "type": "boolean" + } + }, + "title": "carrier", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "carriers" + ], + "title": "list_carriers_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "get_carriers_response_body" + } + } + }, + "description": "The request was a success." + }, + "207": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier list response body", + "properties": { + "carriers": { + "description": "The carrier response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n", + "properties": { + "account_number": { + "description": "The account number that the carrier is connected to.", + "example": "account_570827", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "allows_returns": { + "description": "The carrier has services that support return shipments.", + "readOnly": true, + "type": "boolean" + }, + "balance": { + "description": "Current available balance", + "example": 3799.52, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier.", + "readOnly": true + }, + "connection_status": { + "description": "The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.", + "enum": [ + "pending_approval", + "approved" + ], + "readOnly": true, + "type": "string" + }, + "disabled_by_billing_plan": { + "description": "The carrier is disabled by the current ShipEngine account's billing plan.", + "readOnly": true, + "type": "boolean" + }, + "friendly_name": { + "description": "Screen readable name", + "example": "Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "funding_source_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Funding source ID for the carrier", + "nullable": true, + "readOnly": true + }, + "has_multi_package_supporting_services": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "nickname": { + "description": "Nickname given to the account when initially setting up the carrier.", + "example": "ShipEngine Account - Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "options": { + "description": "A list of options that are available to that carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "packages": { + "description": "A list of package types that are supported by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "primary": { + "description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation", + "readOnly": true, + "type": "boolean" + }, + "requires_funded_amount": { + "description": "Indicates whether the carrier requires funding to use its services", + "readOnly": true, + "type": "boolean" + }, + "send_rates": { + "description": "The carrier provides rates for the shipment.", + "readOnly": true, + "type": "boolean" + }, + "services": { + "description": "A list of services that are offered by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "supports_label_messages": { + "description": "The carrier supports adding custom label messages to an order.", + "readOnly": true, + "type": "boolean" + }, + "supports_user_managed_rates": { + "description": "The carrier supports user-managed rates for shipments.", + "readOnly": true, + "type": "boolean" + } + }, + "title": "carrier", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "carriers" + ], + "title": "list_carriers_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "get_carriers_response_body" + } + } + }, + "description": "The request was a partial success. It contains results, as well as errors." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Carriers", + "tags": [ + "carriers" + ] + }, + "summary": "Carriers" + }, + "/v1/carriers/{carrier_id}": { + "delete": { + "description": "Disconnect a Carrier of the given ID from the account", + "operationId": "disconnect_carrier_by_id", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Disconnect Carrier by ID", + "tags": [ + "carriers" + ] + }, + "description": "Perform actions and get information on individual carriers connected with your account.", + "get": { + "description": "Retrive carrier info by ID", + "operationId": "get_carrier_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A carrier object that represents a provider such as UPS, USPS, DHL, etc\nthat has been tied to the current account.\n", + "properties": { + "account_number": { + "description": "The account number that the carrier is connected to.", + "example": "account_570827", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "allows_returns": { + "description": "The carrier has services that support return shipments.", + "readOnly": true, + "type": "boolean" + }, + "balance": { + "description": "Current available balance", + "example": 3799.52, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier.", + "readOnly": true + }, + "connection_status": { + "description": "The current connection status of the carrier. Indicates whether the carrier connection is pending approval or has been approved for use.", + "enum": [ + "pending_approval", + "approved" + ], + "readOnly": true, + "type": "string" + }, + "disabled_by_billing_plan": { + "description": "The carrier is disabled by the current ShipEngine account's billing plan.", + "readOnly": true, + "type": "boolean" + }, + "friendly_name": { + "description": "Screen readable name", + "example": "Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "funding_source_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Funding source ID for the carrier", + "nullable": true, + "readOnly": true + }, + "has_multi_package_supporting_services": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "nickname": { + "description": "Nickname given to the account when initially setting up the carrier.", + "example": "ShipEngine Account - Stamps.com", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "options": { + "description": "A list of options that are available to that carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "packages": { + "description": "A list of package types that are supported by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "primary": { + "description": "Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation", + "readOnly": true, + "type": "boolean" + }, + "requires_funded_amount": { + "description": "Indicates whether the carrier requires funding to use its services", + "readOnly": true, + "type": "boolean" + }, + "send_rates": { + "description": "The carrier provides rates for the shipment.", + "readOnly": true, + "type": "boolean" + }, + "services": { + "description": "A list of services that are offered by the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "supports_label_messages": { + "description": "The carrier supports adding custom label messages to an order.", + "readOnly": true, + "type": "boolean" + }, + "supports_user_managed_rates": { + "description": "The carrier supports user-managed rates for shipments.", + "readOnly": true, + "type": "boolean" + } + }, + "title": "carrier", + "type": "object" + } + ], + "description": "A get carrier by id response body", + "title": "get_carrier_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Carrier By ID", + "tags": [ + "carriers" + ] + }, + "parameters": [ + { + "description": "Carrier ID", + "example": "se-28529731", + "in": "path", + "name": "carrier_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Individual carriers" + }, + "/v1/carriers/{carrier_id}/add_funds": { + "description": "All carriers require that funds to be attached to an account to ensure payment for the various services they provide to their customers.", + "parameters": [ + { + "description": "Carrier ID", + "example": "se-28529731", + "in": "path", + "name": "carrier_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Add Funds To A Carrier", + "operationId": "add_funds_to_carrier", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "An add funds to carrier request body", + "title": "add_funds_to_carrier_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "The current balance of the requested carrier account", + "properties": { + "balance": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The current balance of the account", + "readOnly": true + } + }, + "required": [ + "balance" + ], + "title": "add_funds_to_carrier_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Add Funds To Carrier", + "tags": [ + "carriers" + ] + }, + "summary": "Carrier Funds" + }, + "/v1/carriers/{carrier_id}/options": { + "description": "Carriers support various options for particular shipments. Ex. (non-machinable, is_alcohol, fragile, etc)", + "get": { + "description": "Get a list of the options available for the carrier", + "operationId": "get_carrier_options", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A carrier list options response body", + "properties": { + "options": { + "description": "AN array of carrier options", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Advanced options that are specific to the carrier", + "properties": { + "default_value": { + "description": "Default value of option", + "example": false, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of option", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of advanced option", + "example": "contains_alcohol", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "carrier_advanced_option", + "type": "object" + } + ], + "description": "Carrer options", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "get_carrier_options_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Carrier Options", + "tags": [ + "carriers" + ] + }, + "parameters": [ + { + "description": "Carrier ID", + "example": "se-28529731", + "in": "path", + "name": "carrier_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Carrier Options" + }, + "/v1/carriers/{carrier_id}/packages": { + "description": "Carriers support many different package types, Shipengine supports retrieving all available package so that\nyou can best determine what is right for your particular shipment.\n", + "get": { + "description": "List the package types associated with the carrier", + "operationId": "list_carrier_package_types", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A list carrier package types response body", + "properties": { + "packages": { + "description": "An array of custom package types", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "Custom Package Type items", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "list_carrier_package_types_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Carrier Package Types", + "tags": [ + "carriers" + ] + }, + "parameters": [ + { + "description": "Carrier ID", + "example": "se-28529731", + "in": "path", + "name": "carrier_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Carrier Packages" + }, + "/v1/carriers/{carrier_id}/services": { + "description": "Carrier services usually refer to the various shipping options that a carrier provides to its customers.\nEx. Priority mail, overnight, international\n", + "get": { + "description": "List the services associated with the carrier ID", + "operationId": "list_carrier_services", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A carrier list services response body", + "properties": { + "services": { + "description": "An array of services associated with the carrier", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A service offered by the carrier", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "domestic": { + "description": "Supports domestic shipping", + "readOnly": true, + "type": "boolean" + }, + "international": { + "description": "Supports international shipping.", + "readOnly": true, + "type": "boolean" + }, + "is_multi_package_supported": { + "description": "Carrier supports multiple packages per shipment", + "readOnly": true, + "type": "boolean" + }, + "is_return_supported": { + "description": "This service supports return shipments.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "User friendly service name", + "example": "USPS First Class Mail", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_code": { + "description": "service code", + "example": "usps_media_mail", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "title": "service", + "type": "object" + } + ], + "description": "A carrier service", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "list_carrier_services_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Carrier Services", + "tags": [ + "carriers" + ] + }, + "parameters": [ + { + "description": "Carrier ID", + "example": "se-28529731", + "in": "path", + "name": "carrier_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Carrier Services" + }, + "/v1/connections/carriers/{carrier_name}": { + "description": "Carrier connections", + "parameters": [ + { + "description": "The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.", + "example": "dhl_express", + "in": "path", + "name": "carrier_name", + "required": true, + "schema": { + "description": "The shipping carriers that are supported by ShipEngine", + "enum": [ + "access_worldwide", + "amazon_buy_shipping", + "amazon_shipping_uk", + "apc", + "asendia", + "australia_post", + "canada_post", + "dhl_ecommerce", + "dhl_express", + "dhl_express_au", + "dhl_express_ca", + "dhl_express_uk", + "dpd", + "endicia", + "fedex", + "fedex_uk", + "firstmile", + "imex", + "newgistics", + "ontrac", + "purolator_canada", + "royal_mail", + "rr_donnelley", + "seko", + "sendle", + "stamps_com", + "ups", + "lasership" + ], + "title": "carrier_name", + "type": "string" + } + } + ], + "post": { + "description": "Connect a carrier account", + "operationId": "connect_carrier", + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "additionalProperties": false, + "description": "An Access Worldwide account information request body", + "properties": { + "nickname": { + "description": "The nickname associated with the carrier connection", + "example": "Stamps.com", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Access Worldwide Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Access Worldwide Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_access_worldwide_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Amazon account information request body", + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "merchant_seller_id": { + "minLength": 1, + "type": "string" + }, + "mws_auth_token": { + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname to be associated with the account connection", + "example": "Test Amazon Buy Shipping", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "merchant_seller_id", + "email", + "mws_auth_token" + ], + "title": "connect_amazon_buy_shipping_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Amazon Shipping UK account information request body", + "properties": { + "auth_code": { + "description": "Amazon UK Shipping auth code.", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "The nickname associated with the carrier connection", + "example": "Stamps.com", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "auth_code" + ], + "title": "connect_amazon_shipping_uk", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An APC account information request body", + "properties": { + "nickname": { + "description": "The nickname for the APC account", + "example": "APC carrier account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The password for the APC account", + "example": 12345, + "minLength": 1, + "type": "string" + }, + "username": { + "description": "The username for the APC account", + "example": "john_doe", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_apc_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Asendia account information request body", + "properties": { + "account_number": { + "description": "Asendia account number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "Asendia api_key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "The nickname of the Asendia account", + "example": "Asendia account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Asendia password", + "minLength": 1, + "type": "string" + }, + "processing_location": { + "description": "Asendia processing location, one of: 'MIA', 'JFK', 'ORD', 'PHL', 'SFO', 'LAX', 'SLC', 'TOR', 'BUF', 'CAL'", + "minLength": 1, + "type": "string" + }, + "sub_account_number": { + "description": "Asendia sub account number", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Asendia username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "username", + "password", + "api_key", + "processing_location" + ], + "title": "connect_asendia_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Australia Post account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "API key", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "description": "API secret", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "api_key", + "api_secret", + "nickname" + ], + "title": "connect_australia_post_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Canada Post account information request body", + "properties": { + "account_number": { + "description": "Canada Post Account Number", + "minLength": 1, + "type": "string" + }, + "api_key": { + "description": "Canada Post Account API Key", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "description": "Canada Post Account API Secret", + "minLength": 1, + "type": "string" + }, + "contract_id": { + "description": "Canada Post Account Contract ID", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "api_key", + "api_secret", + "account_number", + "contract_id" + ], + "title": "connect_canada_post_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Ecommerce account information request body", + "properties": { + "account_number": { + "deprecated": true, + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "ancillary_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "api_key": { + "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", + "minLength": 1, + "type": "string" + }, + "api_secret": { + "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", + "minLength": 1, + "type": "string" + }, + "client_id": { + "description": "The client id", + "minLength": 1, + "type": "string" + }, + "distribution_center": { + "description": "The distribution center", + "minLength": 1, + "type": "string" + }, + "ftp_password": { + "deprecated": true, + "description": "FTP password", + "minLength": 1, + "type": "string" + }, + "ftp_username": { + "deprecated": true, + "description": "FTP username", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "A nickname to help you identify this account", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The account password", + "minLength": 1, + "type": "string" + }, + "pickup_number": { + "description": "The pickup number", + "minLength": 1, + "type": "string" + }, + "registration_id": { + "type": "string" + }, + "software_name": { + "type": "string" + }, + "sold_to": { + "description": "Sold To field", + "type": "string" + }, + "username": { + "description": "The account username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "client_id", + "username", + "password", + "pickup_number", + "distribution_center" + ], + "title": "connect_dhl_ecommerce_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL express account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Required if site id is provided", + "minLength": 1, + "type": "string" + }, + "site_id": { + "description": "Required if password is provided", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Express AU account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_au_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Express CA account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number" + ], + "title": "connect_dhl_express_ca_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DHL Express UK account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "site_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the site" + } + }, + "required": [ + "account_number", + "site_id", + "password", + "nickname" + ], + "title": "connect_dhl_express_uk_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A DPD account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "password", + "nickname" + ], + "title": "connect_dpd_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Endicia account information request body", + "properties": { + "account": { + "description": "Account", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "passphrase": { + "description": "Passphrase", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account", + "passphrase" + ], + "title": "connect_endicia_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Fedex account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "address1": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "address2": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "agree_to_eula": { + "description": "Boolean signaling agreement to the Fedex End User License Agreement", + "type": "boolean" + }, + "city": { + "description": "The city", + "minLength": 1, + "type": "string" + }, + "company": { + "description": "The company", + "minLength": 1, + "type": "string" + }, + "country_code": { + "description": "Country code", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "first_name": { + "description": "First name", + "minLength": 1, + "type": "string" + }, + "last_name": { + "description": "Last name", + "minLength": 1, + "type": "string" + }, + "meter_number": { + "description": "Meter number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal Code", + "minLength": 1, + "type": "string" + }, + "state": { + "description": "State", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "address1", + "city", + "country_code", + "email", + "first_name", + "last_name", + "phone", + "postal_code", + "state", + "nickname", + "agree_to_eula" + ], + "title": "connect_fedex_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Fedex UK account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "address1": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "address2": { + "description": "Address", + "minLength": 1, + "type": "string" + }, + "agree_to_eula": { + "description": "Boolean signaling agreement to the Fedex End User License Agreement", + "type": "boolean" + }, + "city": { + "description": "The city", + "minLength": 1, + "type": "string" + }, + "company": { + "description": "The company", + "minLength": 1, + "type": "string" + }, + "country_code": { + "description": "Country code", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "first_name": { + "description": "First name", + "minLength": 1, + "type": "string" + }, + "last_name": { + "description": "Last name", + "minLength": 1, + "type": "string" + }, + "meter_number": { + "description": "Meter number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal Code", + "minLength": 1, + "type": "string" + }, + "state": { + "description": "State", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "address1", + "city", + "country_code", + "email", + "first_name", + "last_name", + "phone", + "postal_code", + "state", + "nickname", + "agree_to_eula" + ], + "title": "connect_fedex_uk_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A First Mile account information request body", + "properties": { + "mailer_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the mailer" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "profile_name": { + "description": "Profile name", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "mailer_id", + "password" + ], + "title": "connect_firstmile_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Imex account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_imex_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Lasership account information request body", + "properties": { + "Address": { + "description": "Address", + "type": "string," + }, + "Address2": { + "description": "Address2", + "type": "string," + }, + "AttrAlcohol": { + "description": "Set this to true if your shipments will always contain Alcohol", + "type": "boolean," + }, + "AttrControlledSubstance": { + "description": "Set this to true if your shipments will always contain Controlled Substances", + "type": "boolean," + }, + "AttrDryIce": { + "description": "Set this to true if your shipments will always contain DryIce", + "type": "boolean," + }, + "AttrExplosive": { + "description": "Set this to true if your shipments will always contain Explosives", + "type": "boolean," + }, + "AttrHazmat": { + "description": "Set this to true if your shipments will always contain Hazmat", + "type": "boolean," + }, + "AttrNoRTS": { + "description": "Set this to true if your shipments will always use \"No Return To Sender\"", + "type": "boolean," + }, + "AttrPerishable": { + "description": "Set this to true if your shipments will always be Perishable", + "type": "boolean," + }, + "AttrRefrigerated": { + "description": "Set this to true if your shipments will always require Refrigeration", + "type": "boolean," + }, + "AttrTwoPersons": { + "description": "Set this to true if your shipments will always require Two Persons", + "type": "boolean," + }, + "City": { + "description": "City", + "type": "string," + }, + "Email": { + "description": "Email", + "type": "string," + }, + "Phone": { + "description": "Phone", + "type": "string," + }, + "PostalCode": { + "description": "PostalCode", + "type": "string," + }, + "State": { + "description": "State", + "type": "string," + }, + "country": { + "description": "Country", + "type": "string," + }, + "customer_branch": { + "description": "Customer Branch", + "minLength": 1, + "type": "string" + }, + "declare_piece_attributes_separately_for_every_shipment": { + "default": false, + "description": "Declare piece attributes separately for every shipment, overrides individual attribute below.", + "type": "boolean," + }, + "facility_code": { + "description": "Facility Code", + "type": "string," + }, + "instructions": { + "description": "Instructions", + "type": "string," + }, + "lasership_critical_entry_time": { + "description": "Critical Entry Time (local time)", + "type": "string," + }, + "lasership_critical_pull_time": { + "description": "Critical Pull Time (local time)", + "type": "string," + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "web_services_id": { + "description": "Web Service ID (WSID)", + "minLength": 1, + "type": "string" + }, + "web_services_key": { + "description": "Web Service Key (WSKey)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "web_services_id", + "web_services_key", + "customer_branch", + "Address", + "PostalCode", + "City", + "State", + "lasership_critical_pull_time", + "lasership_critical_entry_time" + ], + "title": "connect_lasership_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Newgistics account information request body", + "properties": { + "induction_site": { + "description": "Induction site", + "minLength": 1, + "type": "string" + }, + "mailer_id": { + "description": "Mailer id", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "merchant_id": { + "description": "Merchant id", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "induction_site", + "nickname" + ], + "title": "connect_newgistics_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An Ontrac account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "password" + ], + "title": "connect_ontrac_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Purolator account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "activation_key": { + "description": "Activation key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "activation_key", + "nickname" + ], + "title": "connect_purolator_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Royal Mail account information request body", + "properties": { + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "city": { + "description": "City", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "Company name", + "minLength": 1, + "type": "string" + }, + "contact_name": { + "description": "Contact name", + "minLength": 1, + "type": "string" + }, + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The email address" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "oba_email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ], + "description": "The oba email address" + }, + "phone": { + "description": "Phone", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "description": "Postal code", + "minLength": 1, + "type": "string" + }, + "street_line1": { + "description": "Street line1", + "minLength": 1, + "type": "string" + }, + "street_line2": { + "description": "Street line2", + "minLength": 1, + "type": "string" + }, + "street_line3": { + "description": "Street line3", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_number", + "contact_name", + "city", + "postal_code", + "nickname" + ], + "title": "connect_royal_mail_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A RR Donnelley account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_rr_donnelley_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A SEKO account information request body", + "properties": { + "access_key": { + "description": "Seko Account Access Key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "access_key" + ], + "title": "connect_seko_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Sendle account information request body", + "properties": { + "api_key": { + "description": "API key", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "sendle_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the sendle" + } + }, + "required": [ + "nickname", + "sendle_id", + "api_key" + ], + "title": "connect_sendle_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A Stamps account information request body", + "properties": { + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + }, + "password": { + "description": "Password", + "minLength": 1, + "type": "string" + }, + "username": { + "description": "Username", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "username", + "password" + ], + "title": "connect_stamps_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A UPS account information request body. The location header from this call should be used to redirect to UPS for sign in.", + "properties": { + "account_country_code": { + "description": "Account Country Code", + "minLength": 1, + "type": "string" + }, + "account_number": { + "description": "Account number", + "minLength": 1, + "type": "string" + }, + "account_postal_code": { + "description": "Account Postal Code", + "minLength": 1, + "type": "string" + }, + "nickname": { + "description": "Nickname", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nickname", + "account_number", + "account_postal_code", + "account_country_code" + ], + "title": "connect_ups_request_body", + "type": "object" + } + ], + "title": "connect_carrier_request_body" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A connect account response body", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier" + } + }, + "required": [ + "carrier_id" + ], + "title": "connect_carrier_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Connect a carrier account", + "tags": [ + "carrier_accounts" + ] + }, + "summary": "Carrier connections" + }, + "/v1/connections/carriers/{carrier_name}/{carrier_id}": { + "delete": { + "description": "Disconnect a carrier", + "operationId": "disconnect_carrier", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Disconnect a carrier", + "tags": [ + "carrier_accounts" + ] + }, + "description": "Disconnect a carrier", + "parameters": [ + { + "description": "The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.", + "example": "dhl_express", + "in": "path", + "name": "carrier_name", + "required": true, + "schema": { + "description": "The shipping carriers that are supported by ShipEngine", + "enum": [ + "access_worldwide", + "amazon_buy_shipping", + "amazon_shipping_uk", + "apc", + "asendia", + "australia_post", + "canada_post", + "dhl_ecommerce", + "dhl_express", + "dhl_express_au", + "dhl_express_ca", + "dhl_express_uk", + "dpd", + "endicia", + "fedex", + "fedex_uk", + "firstmile", + "imex", + "newgistics", + "ontrac", + "purolator_canada", + "royal_mail", + "rr_donnelley", + "seko", + "sendle", + "stamps_com", + "ups", + "lasership" + ], + "title": "carrier_name", + "type": "string" + } + }, + { + "description": "Carrier ID", + "example": "se-28529731", + "in": "path", + "name": "carrier_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Disconnect a carrier" + }, + "/v1/connections/carriers/{carrier_name}/{carrier_id}/settings": { + "description": "Carrier settings", + "get": { + "description": "Get carrier settings", + "operationId": "get_carrier_settings", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A DHL Express account settings", + "properties": { + "is_primary_account": { + "description": "Indicates if this is primary account", + "type": "boolean" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "should_hide_account_number_on_archive_doc": { + "description": "Indicates if the account number should be hidden on the archive documentation", + "type": "boolean" + } + }, + "title": "dhl_express_account_settings", + "type": "object" + } + ], + "description": "A DHL Express response body", + "title": "dhl_express_settings_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + } + ], + "description": "A Fedex account settings request body", + "title": "fedex_account_settings_request_body", + "type": "object" + } + ], + "description": "A Fedex settings response body", + "title": "fedex_settings_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "UPS account settings", + "properties": { + "account_postal_code": { + "description": "account postal code", + "minLength": 5, + "type": "string" + }, + "invoice": { + "allOf": [ + { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + } + ], + "description": "The invoice" + }, + "is_primary_account": { + "description": "Indicates if this is the primary UPS account", + "type": "boolean" + }, + "mail_innovations_cost_center": { + "description": "mail innovations cost center", + "minLength": 0, + "type": "string" + }, + "mail_innovations_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "nickname": { + "description": "nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + } + ] + }, + "use_carbon_neutral_shipping_program": { + "description": "The use carbon neutral shipping program", + "type": "boolean" + }, + "use_consolidation_services": { + "description": "The use consolidation services", + "type": "boolean" + }, + "use_ground_freight_pricing": { + "description": "The use ground freight pricing", + "type": "boolean" + }, + "use_negotiated_rates": { + "description": "The use negotiated rates", + "type": "boolean" + }, + "use_order_number_on_mail_innovations_labels": { + "description": "The use order number on mail innovations labels", + "type": "boolean" + } + }, + "title": "ups_account_settings", + "type": "object" + } + ], + "description": "A UPS settings response body", + "title": "ups_settings_response_body", + "type": "object" + } + ], + "title": "get_carrier_settings_response_body" + } + } + }, + "description": "The request was a success." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get carrier settings", + "tags": [ + "carrier_accounts" + ] + }, + "parameters": [ + { + "description": "The carrier name, such as `ups`, `fedex`, or `dhl_express`.", + "example": "dhl_express", + "in": "path", + "name": "carrier_name", + "required": true, + "schema": { + "description": "The shipping carriers for which ShipEngine supports carrier settings", + "enum": [ + "dhl_express", + "fedex", + "newgistics", + "ups" + ], + "title": "carrier_name_with_settings", + "type": "string" + } + }, + { + "description": "Carrier ID", + "example": "se-28529731", + "in": "path", + "name": "carrier_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Update carrier settings", + "operationId": "update_carrier_settings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A DHL Express account settings", + "properties": { + "is_primary_account": { + "description": "Indicates if this is primary account", + "type": "boolean" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "should_hide_account_number_on_archive_doc": { + "description": "Indicates if the account number should be hidden on the archive documentation", + "type": "boolean" + } + }, + "title": "dhl_express_account_settings", + "type": "object" + } + ], + "description": "An update dhl express settings request body", + "title": "update_dhl_express_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A Fedex account settings request body", + "properties": { + "is_primary_account": { + "type": "boolean" + }, + "letterhead_image": { + "type": "string" + }, + "nickname": { + "description": "Account nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "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", + "enum": [ + "none", + "regular_pickup", + "request_courier", + "drop_box", + "business_service_center", + "station" + ], + "title": "fedex_pickup_type", + "type": "string" + } + ] + }, + "signature_image": { + "type": "string" + }, + "smart_post_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "smart_post_hub": { + "allOf": [ + { + "description": "The possible smart post hub values", + "enum": [ + "none", + "allentown_pa", + "atlanta_ga", + "baltimore_md", + "charlotte_nc", + "chino_ca", + "dallas_tx", + "denver_co", + "detroit_mi", + "edison_nj", + "grove_city_oh", + "groveport_oh", + "houston_tx", + "indianapolis_in", + "kansas_city_ks", + "los_angeles_ca", + "martinsburg_wv", + "memphis_tn", + "minneapolis_mn", + "new_berlin_wi", + "northborough_ma", + "orlando_fl", + "phoneix_az", + "pittsburgh_pa", + "reno_nv", + "sacramento_ca", + "salt_lake_city_ut", + "seattle_wa", + "st_louis_mo", + "windsor_ct", + "newark_ny", + "south_brunswick_nj", + "scranton_pa", + "wheeling_il", + "middletown_ct", + "portland_or" + ], + "title": "smart_post_hub", + "type": "string" + } + ] + } + }, + "title": "fedex_account_settings", + "type": "object" + } + ], + "description": "An update Fedex settings request body", + "title": "update_fedex_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A newgistics account settings request body", + "properties": { + "include_barcode_with_order_number": { + "type": "boolean" + }, + "receive_email_on_manifest_processing": { + "type": "boolean" + } + }, + "title": "update_newgistics_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "UPS account settings", + "properties": { + "account_postal_code": { + "description": "account postal code", + "minLength": 5, + "type": "string" + }, + "invoice": { + "allOf": [ + { + "additionalProperties": false, + "description": "UPS invoice", + "properties": { + "control_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the control" + }, + "invoice_amount": { + "minimum": 0, + "type": "number" + }, + "invoice_currency_code": { + "type": "string" + }, + "invoice_date": { + "description": "invoice date", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "invoice_number": { + "description": "invoice number", + "minLength": 1, + "type": "string" + } + }, + "title": "ups_invoice", + "type": "object" + } + ], + "description": "The invoice" + }, + "is_primary_account": { + "description": "Indicates if this is the primary UPS account", + "type": "boolean" + }, + "mail_innovations_cost_center": { + "description": "mail innovations cost center", + "minLength": 0, + "type": "string" + }, + "mail_innovations_endorsement": { + "allOf": [ + { + "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", + "enum": [ + "none", + "return_service_requested", + "forwarding_service_requested", + "address_service_requested", + "change_service_requested", + "leave_if_no_response" + ], + "title": "ancillary_service_endorsement", + "type": "string" + } + ] + }, + "nickname": { + "description": "nickname", + "minLength": 1, + "type": "string" + }, + "pickup_type": { + "allOf": [ + { + "description": "The possible ups pickup type values", + "enum": [ + "daily_pickup", + "occasional_pickup", + "customer_counter" + ], + "title": "ups_pickup_type", + "type": "string" + } + ] + }, + "use_carbon_neutral_shipping_program": { + "description": "The use carbon neutral shipping program", + "type": "boolean" + }, + "use_consolidation_services": { + "description": "The use consolidation services", + "type": "boolean" + }, + "use_ground_freight_pricing": { + "description": "The use ground freight pricing", + "type": "boolean" + }, + "use_negotiated_rates": { + "description": "The use negotiated rates", + "type": "boolean" + }, + "use_order_number_on_mail_innovations_labels": { + "description": "The use order number on mail innovations labels", + "type": "boolean" + } + }, + "title": "ups_account_settings", + "type": "object" + } + ], + "description": "An update UPS settings request body", + "title": "update_ups_settings_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An amazon buy shipping account settings request body", + "properties": { + "email": { + "description": "Email", + "minLength": 1, + "type": "string" + } + }, + "title": "update_amazon_buy_shipping_request_body", + "type": "object" + } + ], + "title": "update_carrier_settings_request_body" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update carrier settings", + "tags": [ + "carrier_accounts" + ] + }, + "summary": "Carrier settings" + }, + "/v1/connections/insurance/shipsurance": { + "delete": { + "description": "Disconnect a Shipsurance Account", + "operationId": "disconnect_insurer", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "title": "disconnect_insurer_response_body", + "type": "object" + } + } + }, + "description": "The request was a success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Disconnect a Shipsurance Account", + "tags": [ + "insurance" + ] + }, + "description": "Shipsurance Connection", + "post": { + "description": "Connect a Shipsurance Account", + "operationId": "connect_insurer", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A create shipsurance connection request body", + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "policy_id": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "email", + "policy_id" + ], + "title": "connect_insurer_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "title": "connect_insurer_response_body", + "type": "object" + } + } + }, + "description": "The request was a success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Connect a Shipsurance Account", + "tags": [ + "insurance" + ] + }, + "summary": "Shipsurance Connection" + }, + "/v1/documents/combined_labels": { + "description": "Download a combined label file", + "post": { + "description": "Download a combined label file", + "operationId": "create_combined_label_document", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A create combined label document request body", + "properties": { + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "inline" + }, + "label_format": { + "description": "The file format for the combined label document; note that currently only `\"pdf\"` is supported.", + "enum": [ + "pdf" + ], + "type": "string" + }, + "label_ids": { + "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", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "title": "create_combined_label_document_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A create combined label document response body", + "properties": { + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The download for the combined label document", + "readOnly": true + } + }, + "title": "create_combined_label_document_response_body.yaml", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Created Combined Label Document", + "tags": [ + "labels" + ] + }, + "summary": "Created Combined Label Document" + }, + "/v1/downloads/{dir}/{subdir}/{filename}": { + "description": "This endpoint is used to download forms that are generated in the various pdf, png, zpl formats\nsuch as labels and batches\n", + "get": { + "description": "Get File", + "operationId": "download_file", + "parameters": [ + { + "in": "query", + "name": "download", + "required": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "rotation", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/pdf": { + "schema": { + "format": "binary", + "title": "download_file_pdf_response_body", + "type": "string" + } + }, + "application/zpl": { + "schema": { + "format": "binary", + "title": "download_file_zpl_response_body", + "type": "string" + } + }, + "image/png": { + "schema": { + "format": "binary", + "title": "download_file_png_response_body", + "type": "string" + } + } + }, + "description": "The request was a success" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Download File", + "tags": [ + "downloads" + ] + }, + "parameters": [ + { + "in": "path", + "name": "subdir", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "filename", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "dir", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "File Download" + }, + "/v1/environment/webhooks": { + "description": "ShipEngine exposes asynchronous operations for long running operations such as batch labels and rates.\nWebhooks allow the ShipEngine servers to contact your servers when an operation changes state, such as a batch label creation completion.\n", + "get": { + "description": "List all webhooks currently enabled for the account.", + "operationId": "list_webhooks", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "A webhook list response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A webhook", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + }, + "webhook_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the webhook", + "readOnly": true + } + }, + "title": "webhook", + "type": "object" + } + ], + "description": "The webhook list response body" + }, + "title": "list_webhooks_response_body", + "type": "array" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Webhooks", + "tags": [ + "webhooks" + ] + }, + "post": { + "description": "Create a webhook for specific events in the environment.", + "operationId": "create_webhook", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A create webhook request body", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My New Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + } + }, + "required": [ + "event", + "url" + ], + "title": "create_webhook_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A webhook", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + }, + "webhook_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the webhook", + "readOnly": true + } + }, + "title": "webhook", + "type": "object" + } + ], + "description": "A webhook response body", + "required": [ + "webhook_id", + "url", + "event" + ], + "title": "create_webhook_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "409": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request conflicts with an existing resource." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create a Webhook", + "tags": [ + "webhooks" + ] + }, + "summary": "Webhooks" + }, + "/v1/environment/webhooks/{webhook_id}": { + "delete": { + "description": "Delete a webhook", + "operationId": "delete_webhook", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Delete Webhook By ID", + "tags": [ + "webhooks" + ] + }, + "description": "Retrieve, update, and delete information for individual webhooks", + "get": { + "description": "Retrieve individual webhook by an ID", + "operationId": "get_webhook_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A webhook", + "properties": { + "event": { + "allOf": [ + { + "description": "The possible webhook event values", + "enum": [ + "batch", + "carrier_connected", + "order_source_refresh_complete", + "rate", + "report_complete", + "sales_orders_imported", + "track" + ], + "title": "webhook_event", + "type": "string" + } + ] + }, + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the webhook sends the request to", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + }, + "webhook_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the webhook", + "readOnly": true + } + }, + "title": "webhook", + "type": "object" + } + ], + "description": "A get webhook id response body", + "required": [ + "webhook_id", + "url", + "event" + ], + "title": "get_webhook_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Webhook By ID", + "tags": [ + "webhooks" + ] + }, + "parameters": [ + { + "description": "Webhook ID", + "in": "path", + "name": "webhook_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Update the webhook url property", + "operationId": "update_webhook", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An update webhook request body", + "properties": { + "headers": { + "description": "Array of custom webhook headers", + "items": { + "allOf": [ + { + "description": "Optional header to be specified in webhook", + "properties": { + "key": { + "description": "Key/name of a header", + "example": "custom-key", + "min_length": 1, + "title": "key", + "type": "string" + }, + "value": { + "description": "Value of a header", + "example": "custom-value", + "title": "value", + "type": "string" + } + }, + "required": [ + "key", + "value" + ], + "title": "webhook_header", + "type": "object" + } + ] + }, + "type": "array" + }, + "name": { + "description": "The name of the webhook", + "example": "My Updated Webhook", + "type": "string" + }, + "store_id": { + "description": "Store ID", + "example": 123456, + "format": "int32", + "type": "integer" + }, + "url": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The url that the wehbook sends the request", + "example": "https://[YOUR ENDPOINT ID].x.requestbin.com" + } + }, + "title": "update_webhook_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update a Webhook", + "tags": [ + "webhooks" + ] + }, + "summary": "Webhook" + }, + "/v1/insurance/shipsurance/add_funds": { + "description": "[Shipsurance](https://www.shipsurance.com/) is a shipping insurance company offering coverage for shipments sent via the major shipping carriers worldwide.\n", + "patch": { + "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", + "operationId": "add_funds_to_insurance", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "An add funds to insurance request body", + "title": "add_funds_to_insurance_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Add funds to insurance response body", + "title": "add_funds_to_insurance_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Add Funds To Insurance", + "tags": [ + "insurance" + ] + }, + "summary": "Shipsurance" + }, + "/v1/insurance/shipsurance/balance": { + "description": "[Shipsurance](https://www.shipsurance.com/) is a shipping insurance company offering coverage for shipments sent via the major shipping carriers worldwide.\n", + "get": { + "description": "Retrieve the balance of your Shipsurance account.", + "operationId": "get_insurance_balance", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "A get insurance balance response body", + "title": "get_insurance_balance_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Insurance Funds Balance", + "tags": [ + "insurance" + ] + }, + "summary": "Shipsurance" + }, + "/v1/labels": { + "description": "Print shipping labels for any of the top global carriers in minutes\u2014instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/)\nin the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n", + "get": { + "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", + "operationId": "list_labels", + "parameters": [ + { + "description": "Only return labels that are currently in the specified status", + "in": "query", + "name": "label_status", + "required": false, + "schema": { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + }, + { + "description": "Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)", + "example": "usps_first_class_mail", + "in": "query", + "name": "service_code", + "required": false, + "schema": { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + }, + { + "description": "Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)", + "in": "query", + "name": "carrier_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Only return labels with a specific tracking number", + "example": "9405511899223197428490", + "in": "query", + "name": "tracking_number", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)", + "in": "query", + "name": "batch_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Rate ID", + "in": "query", + "name": "rate_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Shipment ID", + "in": "query", + "name": "shipment_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)", + "in": "query", + "name": "warehouse_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Only return labels that were created on or after a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only return labels that were created on or before a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only return labels with specific refund status/es.", + "example": "pending,approved", + "explode": false, + "in": "query", + "name": "refund_status", + "required": false, + "schema": { + "items": { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + }, + "type": "array" + } + }, + { + "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", + "example": 2, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 1, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "The number of results to return per response.", + "example": 50, + "in": "query", + "name": "page_size", + "required": false, + "schema": { + "default": 25, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Controls the sort order of the query.", + "in": "query", + "name": "sort_dir", + "required": false, + "schema": { + "allOf": [ + { + "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", + "enum": [ + "asc", + "desc" + ], + "title": "sort_dir", + "type": "string" + } + ], + "default": "desc" + } + }, + { + "description": "Controls which field the query is sorted by.", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "default": "created_at", + "enum": [ + "modified_at", + "created_at", + "voided_at" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": true, + "description": "Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.\n", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ] + }, + "page": { + "description": "The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.", + "example": 1, + "minimum": 1, + "type": "integer" + }, + "pages": { + "description": "The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.", + "example": 4, + "minimum": 0, + "type": "integer" + }, + "total": { + "description": "The total number of items across all pages of results", + "example": 2750, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total", + "page", + "pages", + "links" + ], + "title": "paged_list_response_body", + "type": "object" + } + ], + "description": "A list label response body", + "properties": { + "labels": { + "description": "The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the `page_size`.\n", + "items": { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + }, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "labels" + ], + "title": "list_labels_response_body", + "type": "object" + } + } + }, + "description": "The response includes a `labels` array containing a page of results (as determined by the `page_size` query parameter). It also includes other useful information, such as the total number of labels that match the query criteria, the number of pages of results, and the URLs of the first, last, next, and previous pages of results.\n" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List labels", + "tags": [ + "labels" + ] + }, + "post": { + "description": "Purchase and print a label for shipment", + "operationId": "create_label", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "required": [ + "phone", + "country_code" + ], + "title": "shipping_address_from", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + } + }, + "required": [ + "carrier_id", + "service_code", + "ship_to", + "packages" + ], + "title": "shipment_request", + "type": "object" + } + ], + "description": "The shipment information used to generate the label" + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation", + "writeOnly": true + } + }, + "title": "label_request", + "type": "object" + } + ], + "description": "A purchase label request body", + "properties": { + "ship_from_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + }, + "ship_to_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + } + }, + "required": [ + "shipment" + ], + "title": "create_label_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create label response body", + "required": [ + "label_id", + "status", + "shipment_id", + "external_shipment_id", + "external_order_id", + "ship_date", + "created_at", + "shipment_cost", + "insurance_cost", + "tracking_number", + "is_international", + "batch_id", + "carrier_id", + "service_code", + "voided", + "label_image_id", + "label_format", + "label_layout", + "trackable", + "carrier_code", + "tracking_status", + "label_download", + "form_download", + "qr_code_download", + "paperless_download", + "insurance_claim", + "packages", + "is_return_label", + "rma_number", + "charge_event", + "package_code", + "display_scheme", + "ship_to" + ], + "title": "create_label_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Purchase Label", + "tags": [ + "labels" + ] + }, + "summary": "Print shipping labels" + }, + "/v1/labels/external_shipment_id/{external_shipment_id}": { + "description": "Find a label using the external shipment id", + "get": { + "description": "Find a label by using the external shipment id that was used during label creation\n", + "operationId": "get_label_by_external_shipment_id", + "parameters": [ + { + "example": "url", + "in": "query", + "name": "label_download_type", + "required": false, + "schema": { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A get label by external shipment id response body", + "title": "get_label_by_external_shipment_id_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Label By External Shipment ID", + "tags": [ + "labels" + ] + }, + "parameters": [ + { + "example": "0bcb569d-1727-4ff9-ab49-b2fec0cee5ae", + "in": "path", + "name": "external_shipment_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "Get Label By External Shipment ID" + }, + "/v1/labels/rate_shopper_id/{rate_shopper_id}": { + "description": "Purchase and print a label using Rate Shopper to automatically select carrier and service", + "parameters": [ + { + "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", + "in": "path", + "name": "rate_shopper_id", + "required": true, + "schema": { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + } + ], + "post": { + "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", + "operationId": "create_label_from_rate_shopper", + "parameters": [ + { + "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", + "in": "path", + "name": "rate_shopper_id", + "required": true, + "schema": { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "domestic_shipment": { + "summary": "Domestic shipment with Rate Shopper", + "value": { + "label_format": "pdf", + "label_layout": "4x6", + "shipment": { + "packages": [ + { + "dimensions": { + "height": 6, + "length": 12, + "unit": "inch", + "width": 8 + }, + "weight": { + "unit": "pound", + "value": 5 + } + } + ], + "ship_from": { + "address_line1": "456 Warehouse Blvd", + "city_locality": "Dallas", + "country_code": "US", + "name": "Warehouse A", + "postal_code": "75001", + "state_province": "TX" + }, + "ship_to": { + "address_line1": "123 Main St", + "city_locality": "Austin", + "company_name": "Example Corp", + "country_code": "US", + "name": "John Doe", + "phone": "512-555-1234", + "postal_code": "78701", + "state_province": "TX" + } + } + } + } + }, + "schema": { + "additionalProperties": false, + "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", + "properties": { + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment_for_rate_shopper", + "type": "object" + } + ], + "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" + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation", + "writeOnly": true + } + }, + "required": [ + "shipment" + ], + "title": "create_label_rate_shopper_request_body", + "type": "object" + } + } + }, + "description": "Label creation details with inline shipment", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "successful_label": { + "summary": "Successfully created label", + "value": { + "batch_id": "", + "carrier_code": "stamps_com", + "carrier_id": "se-456789", + "charge_event": "carrier_default", + "created_at": "2026-02-25T10:30:00Z", + "form_download": null, + "insurance_claim": null, + "insurance_cost": { + "amount": 0, + "currency": "usd" + }, + "is_international": false, + "is_return_label": false, + "label_download": { + "href": "https://api.shipengine.com/v1/downloads/10/label-123456.pdf", + "pdf": "https://api.shipengine.com/v1/downloads/10/label-123456.pdf", + "png": "https://api.shipengine.com/v1/downloads/10/label-123456.png", + "zpl": "https://api.shipengine.com/v1/downloads/10/label-123456.zpl" + }, + "label_format": "pdf", + "label_id": "se-123456", + "label_image_id": null, + "label_layout": "4x6", + "package_code": "package", + "packages": [], + "rate_shopper_id": "cheapest", + "rma_number": null, + "service_code": "usps_priority_mail", + "ship_date": "2026-02-25T00:00:00Z", + "shipment_cost": { + "amount": 7.33, + "currency": "usd" + }, + "shipment_id": "se-789012", + "status": "completed", + "trackable": true, + "tracking_number": "1Z999AA10123456784", + "tracking_status": "in_transit", + "voided": false, + "voided_at": null + } + } + }, + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "The response from creating a label using the Rate Shopper. Includes all standard\nlabel information plus the rate_shopper_id indicating which strategy was used.\n", + "properties": { + "rate_shopper_id": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ], + "description": "The rate selection strategy that was used to create this label. This will\nmatch the rate_shopper_id provided in the request path.\n", + "readOnly": true + } + }, + "title": "create_label_rate_shopper_response_body", + "type": "object" + } + } + }, + "description": "Label created successfully using Rate Shopper. The response includes the\nselected carrier_id, service_code, and rate_shopper_id that was used.\n" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Purchase Label from Rate Shopper", + "tags": [ + "labels" + ] + }, + "summary": "Purchase Label from Rate Shopper" + }, + "/v1/labels/rates/{rate_id}": { + "description": "Purchase a label using a `rate_id` that has been previously generated while looking at various rates for a particular shipment.", + "parameters": [ + { + "description": "Rate ID", + "in": "path", + "name": "rate_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "post": { + "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", + "operationId": "create_label_from_rate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A purchase label without shipment resource", + "properties": { + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url" + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ] + } + }, + "title": "purchase_label_without_shipment", + "type": "object" + } + ], + "description": "A purchase label without shipment request body", + "properties": { + "custom_field1": { + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field1", + "type": "string" + }, + "custom_field2": { + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field2", + "type": "string" + }, + "custom_field3": { + "description": "Optional - Value will be saved in the shipment's advanced_options > custom_field3", + "type": "string" + } + }, + "title": "create_label_from_rate_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create label from rate response body", + "title": "create_label_from_rate_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Purchase Label with Rate ID", + "tags": [ + "labels" + ] + }, + "summary": "Use a rate to purchase a label" + }, + "/v1/labels/shipment/{shipment_id}": { + "description": "Purchase a label using a shipment ID that has already been created with the desired address and\npackage info.\n", + "parameters": [ + { + "description": "Shipment ID", + "in": "path", + "name": "shipment_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "post": { + "description": "Purchase a label using a shipment ID that has already been created with the desired address and\npackage info.\n", + "operationId": "create_label_from_shipment", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A purchase label without shipment request body", + "properties": { + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url" + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf" + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ] + } + }, + "title": "create_label_from_shipment_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create label from shipment response body", + "title": "create_label_from_shipment_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Purchase Label with Shipment ID", + "tags": [ + "labels" + ] + }, + "summary": "Purchase label using shipment ID" + }, + "/v1/labels/{label_id}": { + "description": "Retrieve information for individual labels.", + "get": { + "description": "Retrieve information for individual labels.", + "operationId": "get_label_by_id", + "parameters": [ + { + "example": "url", + "in": "query", + "name": "label_download_type", + "required": false, + "schema": { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A get label by id response body", + "title": "get_label_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Label By ID", + "tags": [ + "labels" + ] + }, + "parameters": [ + { + "description": "Label ID", + "in": "path", + "name": "label_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Label" + }, + "/v1/labels/{label_id}/cancel_refund": { + "description": "Exclude labels from Refund Assist by canceling a scheduled refund request. This endpoint allows you to prevent a label with \"request_scheduled\" refund status from being included in an upcoming automatic refund request.\n", + "parameters": [ + { + "description": "Label ID", + "in": "path", + "name": "label_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "post": { + "description": "Cancel a scheduled refund request for a label. Only labels with refund status \"request_scheduled\" can be excluded from an upcoming refund request.", + "operationId": "cancel_label_refund", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A cancel refund label response body", + "title": "cancel_refund_label_response_body", + "type": "object" + } + } + }, + "description": "The refund cancellation was successful. Returns the updated label object." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Cancel a label refund request", + "tags": [ + "labels" + ] + }, + "summary": "Cancel label refund request" + }, + "/v1/labels/{label_id}/return": { + "parameters": [ + { + "description": "Label ID", + "in": "path", + "name": "label_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "post": { + "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", + "operationId": "create_return_label", + "requestBody": { + "content": { + "application/json": { + "examples": { + "with_custom_rma": { + "description": "Create a return label with a specific RMA number", + "summary": "Return label with custom RMA number", + "value": { + "charge_event": "carrier_default", + "label_format": "pdf", + "label_layout": "4x6", + "rma_number": "RMA-2024-001234" + } + }, + "without_rma": { + "description": "Create a return label using default RMA generation", + "summary": "Return label with auto-generated RMA", + "value": { + "charge_event": "carrier_default", + "label_format": "pdf", + "label_layout": "4x6" + } + } + }, + "schema": { + "additionalProperties": false, + "description": "A create return label request body", + "properties": { + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "rma_number": { + "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", + "nullable": true, + "type": "string" + } + }, + "title": "create_return_label_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "alternative_identifiers": { + "description": "Additional information some carriers may provide by which to identify a given label in their system.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "batch_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.\n", + "readOnly": true + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "readOnly": true + }, + "charge_event": { + "allOf": [ + { + "description": "Determines when the user's account will be charged for the label.", + "enum": [ + "carrier_default", + "on_creation", + "on_carrier_acceptance" + ], + "title": "label_charge_event", + "type": "string" + } + ], + "description": "The label charge event.\n" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "description": "The type of delivery confirmation that is required for this shipment.", + "readOnly": true + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was created in ShipEngine.", + "readOnly": true + }, + "display_scheme": { + "allOf": [ + { + "description": "The display format that the label should be shown in.", + "enum": [ + "label", + "paperless", + "label_and_paperless" + ], + "title": "display_scheme", + "type": "string" + } + ], + "default": "label", + "description": "The display format that the label should be shown in." + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_shipment_id": { + "description": "A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.\n", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.\n", + "nullable": true, + "readOnly": true + }, + "insurance_claim": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.\n", + "nullable": true, + "readOnly": true + }, + "insurance_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost.\n", + "readOnly": true + }, + "is_international": { + "description": "Indicates whether this is an international shipment. That is, the originating country and destination country are different.\n", + "readOnly": true, + "type": "boolean" + }, + "is_return_label": { + "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", + "type": "boolean" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "readOnly": true + }, + "label_download_type": { + "allOf": [ + { + "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", + "enum": [ + "url", + "inline" + ], + "title": "label_download_type", + "type": "string" + } + ], + "default": "url", + "writeOnly": true + }, + "label_format": { + "allOf": [ + { + "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`
`stamps_com`
`ups`
`usps`\n|`zpl` | `access_worldwide`
`apc`
`asendia`
`dhl_global_mail`
`dhl_express`
`dhl_express_australia`
`dhl_express_canada`
`dhl_express_worldwide`
`dhl_express_uk`
`dpd`
`endicia`
`fedex`
`fedex_uk`
`firstmile`
`imex`
`newgistics`
`ontrac`
`rr_donnelley`
`stamps_com`
`ups`
`usps`\n", + "enum": [ + "pdf", + "png", + "zpl" + ], + "title": "label_format", + "type": "string" + } + ], + "default": "pdf", + "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" + }, + "label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.\n", + "readOnly": true + }, + "label_image_id": { + "allOf": [ + { + "description": "Used to identify an image resource.", + "example": "img_DtBXupDBxREpHnwEXhTfgK", + "minLength": 4, + "title": "image_id", + "type": "string" + } + ], + "description": "The label image resource that was used to create a custom label image.", + "nullable": true + }, + "label_layout": { + "allOf": [ + { + "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", + "enum": [ + "4x6", + "letter", + "A4", + "A6" + ], + "title": "label_layout", + "type": "string" + } + ], + "default": "4x6", + "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" + }, + "outbound_label_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "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", + "writeOnly": true + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "packages": { + "description": "The label's package(s).\n\n> **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package returned in the response from creating a [shipping label](https://www.shipengine.com/docs/labels/create-a-label/)\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "form_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The form download for any customs that are needed", + "readOnly": true + }, + "has_form_documents": { + "description": "Whether the package has form documents available for download", + "type": "boolean" + }, + "has_label_documents": { + "description": "Whether the package has label documents available for download", + "type": "boolean" + }, + "has_paperless_label_documents": { + "description": "Whether the package has paperless documents available for download", + "type": "boolean" + }, + "has_qr_code_documents": { + "description": "Whether the package has QR code documents available for download", + "type": "boolean" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Reference to the various downloadable file formats for the generated label\n", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "pdf": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the pdf generated label" + }, + "png": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the png generated label" + }, + "zpl": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL for the zpl generated label" + } + }, + "title": "label_download", + "type": "object" + } + ], + "description": "The label download for the package", + "readOnly": true + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "description": "The shipment package id", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.", + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "readOnly": true + }, + "sequence": { + "description": "Package sequence", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "label_package", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "alternative_identifiers": { + "description": "Alternative identifiers associated with this package.\n", + "items": { + "additionalProperties": false, + "description": "Additional information some carriers may provide by which to identify a given label in their system. \n", + "properties": { + "type": { + "description": "The type of alternative_identifier that corresponds to the value.\n", + "example": "last_mile_tracking_number", + "minLength": 1, + "type": "string" + }, + "value": { + "description": "The value of the alternative_identifier.\n", + "example": "12345678912345678912", + "minLength": 1, + "type": "string" + } + }, + "title": "alternative_identifier", + "type": "object" + }, + "nullable": true, + "readOnly": true, + "type": "array" + } + }, + "title": "alternative_identifiers", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "paperless_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "properties": { + "handoff_code": { + "default": null, + "description": "The handoff code for the paperless download.\n", + "nullable": true, + "type": "string" + }, + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "instructions": { + "default": null, + "description": "The instructions for the paperless download.\n", + "nullable": true, + "type": "string" + } + }, + "title": "paperless_download", + "type": "object" + } + ], + "description": "The paperless details which may contain elements like `href`, `instructions` and `handoff_code`.\n", + "nullable": true, + "readOnly": true + }, + "qr_code_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The QR code download for the package", + "nullable": true, + "readOnly": true + }, + "rate_details": { + "description": "A list of rate details that are associated with shipping cost. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "refund_details": { + "allOf": [ + { + "additionalProperties": false, + "description": "Information about a Refund Assist label. This object contains details about the refund request status and associated monetary amounts.\n", + "properties": { + "amount_approved": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount approved for refund by the carrier", + "nullable": true, + "readOnly": true + }, + "amount_credited": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that has been credited back to the account", + "nullable": true, + "readOnly": true + }, + "amount_paid": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount that was originally paid for the label", + "nullable": true, + "readOnly": true + }, + "amount_requested": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The amount requested to be refunded", + "nullable": true, + "readOnly": true + }, + "refund_status": { + "allOf": [ + { + "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", + "enum": [ + "request_scheduled", + "pending", + "approved", + "rejected", + "excluded" + ], + "title": "refund_status", + "type": "string" + } + ], + "description": "The current status of the refund request", + "readOnly": true + }, + "request_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time when the refund request was submitted", + "readOnly": true + } + }, + "title": "refund_details", + "type": "object" + } + ], + "description": "Information about the Refund Assist request for this label. This field is `null` if the label is not eligible for Refund Assist.\n", + "nullable": true, + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.\n", + "readOnly": true + }, + "rma_number": { + "description": "An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.\n", + "nullable": true, + "type": "string" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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", + "readOnly": true + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "description": "The date that the package 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", + "readOnly": true + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address", + "readOnly": true + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "The shipment information used to generate the label", + "writeOnly": true + }, + "shipment_cost": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs.\n", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)\n", + "readOnly": true + }, + "status": { + "allOf": [ + { + "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", + "enum": [ + "processing", + "completed", + "error", + "voided" + ], + "title": "label_status", + "type": "string" + } + ], + "readOnly": true + }, + "test_label": { + "default": false, + "deprecated": true, + "description": "Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.", + "type": "boolean", + "writeOnly": true + }, + "trackable": { + "description": "Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.\n", + "readOnly": true, + "type": "boolean" + }, + "tracking_number": { + "description": "The tracking number for the package. Tracking number formats vary across carriers.", + "example": "782758401696", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "tracking_status": { + "allOf": [ + { + "description": "The different statuses that can apply to a shipment.", + "enum": [ + "unknown", + "in_transit", + "error", + "delivered" + ], + "title": "tracking_status", + "type": "string" + } + ], + "description": "The current status of the package, such as `in_transit` or `delivered`", + "readOnly": true + }, + "tracking_url": { + "description": "The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.\n", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "validate_and_clean", + "writeOnly": true + }, + "void_type": { + "allOf": [ + { + "description": "Indicates how a label was voided. `refund_assist` means the label was voided through the Refund Assist program, while `manual` means it was voided manually by the user.", + "enum": [ + "refund_assist", + "manual" + ], + "title": "void_type", + "type": "string" + } + ], + "description": "Indicates how the label was voided. This field is `null` if the label has not been voided.\n", + "example": "manual", + "nullable": true, + "readOnly": true + }, + "voided": { + "description": "Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)\n", + "readOnly": true, + "type": "boolean" + }, + "voided_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided\n", + "nullable": true, + "readOnly": true + } + }, + "title": "label", + "type": "object" + } + ], + "description": "A create return label response body", + "title": "create_return_label_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create a return label", + "tags": [ + "labels" + ] + }, + "summary": "Return labels" + }, + "/v1/labels/{label_id}/track": { + "description": "Carriers will provide tracking information so the status of your shipment can be monitored", + "get": { + "description": "Retrieve the label's tracking information", + "operationId": "get_tracking_log_from_label", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A tracking information resource", + "properties": { + "actual_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "estimated_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "events": { + "description": "The events that have occured during the lifetime of this tracking number.", + "items": { + "additionalProperties": false, + "description": "A track event", + "properties": { + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Carrier timestamp for the event, it is assumed to be the local time of where the event occurred." + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "city_locality": { + "description": "City locality", + "example": "AUSTIN", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "company_name": { + "description": "Company Name", + "example": "Stamps.com", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "description": { + "description": "Event description", + "example": "Delivered, In/At Mailbox", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "event_code": { + "description": "Event Code", + "minLength": 0, + "type": "string" + }, + "latitude": { + "description": "Latitude coordinate of tracking event.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "description": "Longitude coordinate of tracking event.", + "format": "double", + "maximum": 180, + "minimum": -180, + "type": "number" + }, + "occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Timestamp for carrier event" + }, + "postal_code": { + "description": "Postal code", + "example": 78756, + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "proof_of_delivery_url": { + "description": "A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.", + "example": "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png", + "readOnly": true, + "type": "string" + }, + "signer": { + "description": "Signer information", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "state_province": { + "description": "State province", + "example": "TX", + "minLength": 2, + "readOnly": true, + "type": "string" + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "IT" + }, + "status_description": { + "description": "Event Status Description", + "example": "In Transit", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "IN_TRANSIT" + }, + "status_detail_description": { + "description": "Event Status Detail Description", + "example": "Your shipment is on its way between the carrier hubs.", + "minLength": 0, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "occurred_at", + "city_locality", + "state_province", + "postal_code", + "carrier_detail_code", + "status_code", + "status_description", + "carrier_status_code", + "carrier_status_description" + ], + "title": "track_event", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "exception_description": { + "description": "Exception description", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "DE" + }, + "status_description": { + "description": "Status description", + "example": "Delivered", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "DELIVERED" + }, + "status_detail_description": { + "description": "Status detail description", + "example": "Your parcel has been successfully delivered.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ] + }, + "tracking_url": { + "description": "Carrier Tracking Url, if available", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "readOnly": true, + "type": "string" + } + }, + "title": "tracking_information", + "type": "object" + } + ], + "description": "A get tracking log from label response body", + "required": [ + "tracking_number", + "status_code", + "carrier_status_code", + "events" + ], + "title": "get_tracking_log_from_label_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Label Tracking Information", + "tags": [ + "labels" + ] + }, + "parameters": [ + { + "description": "Label ID", + "in": "path", + "name": "label_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Tracking a Label" + }, + "/v1/labels/{label_id}/void": { + "description": "Some carriers charge for creating a label upon purchase vs upon use. The Shipengine API allows you\nto void a label to get a refund.\n", + "parameters": [ + { + "description": "Label ID", + "in": "path", + "name": "label_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Void a label by ID to get a refund.", + "operationId": "void_label", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A void label response body", + "properties": { + "approved": { + "description": "Indicates whether the attempt to void the label was successful", + "example": false, + "readOnly": true, + "type": "boolean" + }, + "message": { + "example": "Unable to delete FedEx shipment. Unable to retrieve record from database.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "reason_code": { + "allOf": [ + { + "description": "The possible normalized reasons a label void request may not have been approved", + "enum": [ + "unknown", + "unspecified", + "validation_failed", + "label_not_found_within_void_period", + "label_already_used", + "label_already_voided", + "contact_carrier" + ], + "title": "reason_code", + "type": "string" + } + ], + "description": "Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. \u201cunknown\u201d codes may be specified later.", + "example": "label_not_found_within_void_period", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "approved", + "message" + ], + "title": "void_label_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Void a Label By ID", + "tags": [ + "labels" + ] + }, + "summary": "Label Voiding" + }, + "/v1/manifests": { + "description": "Many manifests are sent electronically to the carrier when you create a label, and\noften physical manifests are not necessary. Carriers receive the package details, shipping date,\nand other information that help them plan your package's delivery when you create a label.\n\nHowever, some providers, like USPS require manifests when shipping large numbers of packages. Think about how long it would take for a delivery driver to arrive, pick up 100 packages, and individually scan each of them.\n\nA manifest exists so the carrier can scan the manifest and check in all the packages being shipped.\n", + "get": { + "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.", + "operationId": "list_manifests", + "parameters": [ + { + "description": "Warehouse ID", + "in": "query", + "name": "warehouse_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "ship date start range", + "example": "2018-09-23T15:00:00.000Z", + "in": "query", + "name": "ship_date_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "ship date end range", + "example": "2018-09-23T15:00:00.000Z", + "in": "query", + "name": "ship_date_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Carrier ID", + "in": "query", + "name": "carrier_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "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", + "example": 2, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 1, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "The number of results to return per response.", + "example": 50, + "in": "query", + "name": "page_size", + "required": false, + "schema": { + "default": 25, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "explode": true, + "in": "query", + "name": "label_ids", + "required": false, + "schema": { + "description": "Array of label ids", + "items": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A list manifests response body", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "description": "Helpful links to other pages of results", + "readOnly": true + }, + "manifests": { + "default": [], + "description": "The list of available manifests", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + } + ], + "description": "A single manifest", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "page": { + "description": "Current page of the list manifests results", + "example": 3, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "description": "Total number of pages for list manifests results", + "example": 4, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "total": { + "description": "The total number of manifests returned", + "example": 3, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "manifests", + "total", + "page", + "pages", + "links" + ], + "title": "list_manifests_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Manifests", + "tags": [ + "manifests" + ] + }, + "post": { + "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", + "operationId": "create_manifest", + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "additionalProperties": false, + "description": "A create manifest request body", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier" + }, + "excluded_label_ids": { + "description": "The list of label ids to exclude from the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be excluded from the manifest" + }, + "type": "array" + }, + "label_ids": { + "description": "The list of label ids to include for the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be included for the manifest" + }, + "type": "array" + }, + "ship_date": { + "description": "The ship date that the shipment will be sent out on", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse" + } + }, + "required": [ + "carrier_id", + "warehouse_id", + "ship_date" + ], + "title": "create_manifest_by_object_request_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A create manifest request body", + "properties": { + "label_ids": { + "description": "The list of label ids to include in the manifest", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label Id that will be included in the manifest" + }, + "type": "array" + } + }, + "required": [ + "label_ids" + ], + "title": "create_manifest_label_ids_request_body", + "type": "object" + } + ], + "title": "create_manifest_request_body" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "An array of manifest resources", + "properties": { + "manifests": { + "description": "Resulting Manifests", + "items": { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An array of manifest requests", + "properties": { + "manifest_requests": { + "description": "Resulting manifest requests with statuses", + "items": { + "additionalProperties": false, + "description": "A reference to the manifest request", + "properties": { + "manifest_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies a manifest request", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible statuses of a manifest request", + "enum": [ + "in_progress", + "completed" + ], + "title": "manifest_request_status", + "type": "string" + } + ] + } + }, + "title": "manifest_request", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests_requests", + "type": "object" + }, + { + "additionalProperties": false, + "description": "Deprecated manifest resource", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the carrier" + }, + "created_at": { + "deprecated": true, + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the form" + }, + "label_ids": { + "deprecated": true, + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "deprecated": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the manifest" + }, + "ship_date": { + "deprecated": true, + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "shipments": { + "deprecated": true, + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "deprecated": true, + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the warehouse" + } + }, + "title": "deprecated_manifest", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_with_label_id_response_body", + "type": "object" + } + ], + "description": "A create manifest response body", + "required": [ + "manifest_id", + "form_id", + "created_at", + "ship_date", + "shipments", + "warehouse_id", + "submission_id", + "carrier_id", + "manifest_download" + ], + "title": "create_manifest_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create Manifest", + "tags": [ + "manifests" + ] + }, + "summary": "Manifests" + }, + "/v1/manifests/requests/{manifest_request_id}": { + "description": "Manifest Request ID", + "get": { + "description": "Get Manifest Request By Id", + "operationId": "get_manifest_request_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "An array of manifest resources", + "properties": { + "manifests": { + "description": "Resulting Manifests", + "items": { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An array of manifest requests", + "properties": { + "manifest_requests": { + "description": "Resulting manifest requests with statuses", + "items": { + "additionalProperties": false, + "description": "A reference to the manifest request", + "properties": { + "manifest_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies a manifest request", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible statuses of a manifest request", + "enum": [ + "in_progress", + "completed" + ], + "title": "manifest_request_status", + "type": "string" + } + ] + } + }, + "title": "manifest_request", + "type": "object" + }, + "type": "array" + } + }, + "title": "manifests_requests", + "type": "object" + }, + { + "additionalProperties": false, + "description": "Deprecated manifest resource", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the carrier" + }, + "created_at": { + "deprecated": true, + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the form" + }, + "label_ids": { + "deprecated": true, + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "deprecated": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the manifest" + }, + "ship_date": { + "deprecated": true, + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "type": "string" + }, + "shipments": { + "deprecated": true, + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "deprecated": true, + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the warehouse" + } + }, + "title": "deprecated_manifest", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_with_label_id_response_body", + "type": "object" + } + ], + "description": "A create manifest response body", + "required": [ + "manifest_id", + "form_id", + "created_at", + "ship_date", + "shipments", + "warehouse_id", + "submission_id", + "carrier_id", + "manifest_download" + ], + "title": "create_manifest_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Manifest Request By Id", + "tags": [ + "manifests" + ] + }, + "parameters": [ + { + "description": "The Manifest Request Id", + "in": "path", + "name": "manifest_request_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Manifest Request ID" + }, + "/v1/manifests/{manifest_id}": { + "description": "Manifest ID", + "get": { + "description": "Get Manifest By Id", + "operationId": "get_manifest_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "Used for combining packages into one scannable form that a carrier can use when picking up a large \nnumber of shipments\n", + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "created_at": { + "description": "The date-time that the manifest was created", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "form_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the form", + "readOnly": true + }, + "label_ids": { + "description": "An array of the label ids used in this manifest.", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "manifest_download": { + "allOf": [ + { + "additionalProperties": false, + "description": "Object containing the href link to download the manifest file", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + } + }, + "title": "manifest_download", + "type": "object" + } + ], + "readOnly": true + }, + "manifest_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the manifest", + "readOnly": true + }, + "ship_date": { + "description": "The date-time that the manifests shipments will be picked up", + "example": "2019-07-12T13:37:39.050Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipments": { + "description": "The number of shipments that are included in this manifest", + "example": 100, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "submission_id": { + "description": "A string that uniquely identifies the submission", + "example": "9475711899564878915476", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "manifest", + "type": "object" + } + ], + "description": "A get manifest by id response body", + "required": [ + "manifest_id", + "form_id", + "created_at", + "ship_date", + "shipments", + "warehouse_id", + "submission_id", + "carrier_id", + "manifest_download", + "label_ids" + ], + "title": "get_manifest_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Manifest By Id", + "tags": [ + "manifests" + ] + }, + "parameters": [ + { + "description": "The Manifest Id", + "in": "path", + "name": "manifest_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Manifest ID" + }, + "/v1/packages": { + "description": "Sometimes the default package types that carriers provide aren't enough and you need to create your own. That's where\nthe `/packages` endpoint becomes useful. Create, manage, and delete custom package types to suit your specific needs.\n", + "get": { + "description": "List the custom package types associated with the account", + "operationId": "list_package_types", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A list package types response body", + "properties": { + "packages": { + "description": "An array of custom package types", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "Custom Package Types items", + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "title": "list_package_types_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Custom Package Types", + "tags": [ + "package_types" + ] + }, + "post": { + "description": "Create a custom package type to better assist in getting accurate rate estimates", + "operationId": "create_package_type", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "A create package type request body", + "title": "create_package_type_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "A create package type response body", + "title": "create_package_type_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create Custom Package Type", + "tags": [ + "package_types" + ] + }, + "summary": "Packages" + }, + "/v1/packages/{package_id}": { + "delete": { + "description": "Delete a custom package using the ID", + "operationId": "delete_package_type", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Delete A Custom Package By ID", + "tags": [ + "package_types" + ] + }, + "description": "Create, edit, and delete individual custom packages.", + "get": { + "description": "Get Custom Package Type by ID", + "operationId": "get_package_type_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "A get package type by id response body", + "title": "get_package_type_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Custom Package Type By ID", + "tags": [ + "package_types" + ] + }, + "parameters": [ + { + "description": "Package ID", + "in": "path", + "name": "package_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Update the custom package type object by ID", + "operationId": "update_package_type", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A package type that a carrier supports for shipment.", + "properties": { + "description": { + "description": "Provides a helpful description for the custom package.", + "example": "Packaging for laptops", + "maxLength": 500, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The custom dimensions for the package." + }, + "name": { + "example": "laptop_box", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ] + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the package." + } + }, + "required": [ + "name", + "package_code" + ], + "title": "package_type", + "type": "object" + } + ], + "description": "An update package type request body", + "title": "update_package_type_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Custom Package Type By ID", + "tags": [ + "package_types" + ] + }, + "summary": "Package" + }, + "/v1/pickups": { + "description": "Scheduled package pickups\n", + "get": { + "description": "List all pickups that have been scheduled for this carrier", + "operationId": "list_scheduled_pickups", + "parameters": [ + { + "description": "Carrier ID", + "in": "query", + "name": "carrier_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Warehouse ID", + "in": "query", + "name": "warehouse_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Only return scheduled pickups that were created on or after a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only return scheduled pickups that were created on or before a specific date/time", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "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", + "example": 2, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 1, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "The number of results to return per response.", + "example": 50, + "in": "query", + "name": "page_size", + "required": false, + "schema": { + "default": 25, + "format": "int32", + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "description": "A list pickup response body", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "description": "Helpful links to other pages of results", + "readOnly": true + }, + "page": { + "description": "Current page of the list pickups results", + "example": 3, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "description": "Total number of pages for list pickups results", + "example": 4, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pickups": { + "description": "An array of pickups associated with the user's account.", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ] + }, + "type": "array" + }, + "total": { + "description": "The total number of pickups returned", + "example": 3, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "pickups", + "total", + "page", + "pages", + "links" + ], + "title": "list_pickup_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "get_pickups_response_body" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Scheduled Pickups", + "tags": [ + "package_pickups" + ] + }, + "post": { + "description": "Schedule a package pickup with a carrier", + "operationId": "schedule_pickup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ], + "description": "A schedule pickup request body", + "required": [ + "contact_details", + "label_ids", + "pickup_window" + ], + "title": "schedule_pickup_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "schedule_pickup_response_body" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Schedule a Pickup", + "tags": [ + "package_pickups" + ] + }, + "summary": "Scheduled Pickups" + }, + "/v1/pickups/{pickup_id}": { + "delete": { + "description": "Delete a previously-scheduled pickup by ID", + "operationId": "delete_scheduled_pickup", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A delete scheduled pickup response body", + "properties": { + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ] + } + }, + "required": [ + "pickup_id" + ], + "title": "delete_scheduled_pickup_response_body", + "type": "object" + } + ], + "title": "delete_pickup_by_id_response_body" + } + } + }, + "description": "Return the `pickup_id` of the scheduled pickup that was successfully deleted\n" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Delete a Scheduled Pickup", + "tags": [ + "package_pickups" + ] + }, + "description": "A package pickup that has been scheduled with a carrier\n", + "get": { + "description": "Get Pickup By ID", + "operationId": "get_pickup_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to schedule a package pickup\n", + "properties": { + "cancelled_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was cancelled in ShipEngine.", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier_id associated with the pickup", + "readOnly": true + }, + "confirmation_number": { + "description": "The carrier confirmation number for the scheduled pickup.", + "example": "292513CL4A3", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "contact_details": { + "properties": { + "email": { + "allOf": [ + { + "description": "An email address.", + "example": "john.doe@example.com", + "format": "email", + "minLength": 1, + "title": "email", + "type": "string" + } + ] + }, + "name": { + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "Phone number associated", + "minLength": 7, + "type": "string" + } + }, + "required": [ + "name", + "email", + "phone" + ], + "title": "contact_details", + "type": "object" + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the pickup was created in ShipEngine.", + "readOnly": true + }, + "label_ids": { + "description": "Label IDs that will be included in the pickup request", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "Label ID that will be included in the pickup request" + }, + "type": "array" + }, + "pickup_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "readOnly": true + }, + "pickup_id": { + "allOf": [ + { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + ], + "readOnly": true + }, + "pickup_notes": { + "description": "Used by some carriers to give special instructions for a package pickup", + "minLength": 0, + "type": "string" + }, + "pickup_window": { + "description": "The desired time range for the package pickup.", + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "required": [ + "start_at", + "end_at" + ], + "title": "pickup_window", + "type": "object", + "writeOnly": true + }, + "pickup_windows": { + "description": "An array of available pickup windows. Carriers can return multiple times that they will pickup packages.\n", + "items": { + "allOf": [ + { + "properties": { + "end_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "start_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + } + }, + "title": "pickup_windows", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The warehouse_id associated with the pickup", + "readOnly": true + } + }, + "title": "pickup", + "type": "object" + } + ], + "description": "A pickup response body", + "required": [ + "pickup", + "pickup_id", + "label_ids", + "created_at", + "carrier_id", + "warehouse_id", + "pickup_address", + "contact_details", + "notes", + "pickup_window", + "confirmation_number" + ], + "title": "pickup_response_body", + "type": "object" + }, + { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + ], + "title": "get_pickup_by_id_response_body" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Pickup By ID", + "tags": [ + "package_pickups" + ] + }, + "parameters": [ + { + "in": "path", + "name": "pickup_id", + "required": true, + "schema": { + "description": "Pickup Resource ID", + "example": "pik_3YcKU5zdtJuCqoeNwyqqbW", + "minLength": 4, + "title": "pickup_resource_id", + "type": "string" + } + } + ], + "summary": "Scheduled Pickup" + }, + "/v1/rates": { + "description": "Get the various rates for a set of carriers", + "post": { + "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", + "operationId": "calculate_rates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "rate_options": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate request body", + "properties": { + "calculate_tax_amount": { + "description": "Calculate the duties and tariffs for cross border shipments.", + "type": "boolean" + }, + "carrier_ids": { + "description": "Array of carrier ids to get rates for", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier ids" + }, + "minItems": 1, + "type": "array" + }, + "is_return": { + "description": "Indicate if it's a return shipment", + "type": "boolean" + }, + "package_types": { + "items": { + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "preferred_currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + }, + "rate_type": { + "description": "Indicates what type of rating to perform", + "enum": [ + "check", + "shipment", + "quick" + ], + "type": "string" + }, + "service_codes": { + "items": { + "description": "Item Service Codes", + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "carrier_ids" + ], + "title": "rate_request_body", + "type": "object" + } + ], + "description": "The rate options" + } + }, + "title": "rate_request_options", + "type": "object" + } + ], + "description": "A rate shipment request body", + "oneOf": [ + { + "properties": { + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment" + } + }, + "title": "shipment_id_request", + "type": "object" + }, + { + "properties": { + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ], + "description": "The shipment object" + } + }, + "title": "rate_shipment_request", + "type": "object" + } + ], + "properties": { + "ship_from_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + }, + "ship_to_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + } + }, + "required": [ + "shipment_id", + "shipment" + ], + "title": "calculate_rates_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "rate_response": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rates information resource", + "properties": { + "created_at": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "When the rate was created", + "format": "date-time", + "type": "string" + }, + "errors": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "type": "array" + }, + "invalid_rates": { + "default": [], + "description": "An array of invalid shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "nullable": true, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "Invalid Shipment Rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "rates": { + "description": "An array of shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "nullable": true, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + }, + { + "properties": { + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "description": "Shipment Rates", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "title": "rates_information", + "type": "object" + } + ], + "description": "The rates response" + } + }, + "title": "rate_response", + "type": "object" + } + ], + "description": "A rate shipment response body", + "required": [ + "rate_response", + "shipment_id", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "calculate_rates_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Shipping Rates", + "tags": [ + "rates" + ] + }, + "summary": "Rates" + }, + "/v1/rates/bulk": { + "description": "Get specific rates for large groups of shipments", + "post": { + "description": "Get Bulk Shipment Rates", + "operationId": "compare_bulk_rates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "rate_options": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate request body", + "properties": { + "calculate_tax_amount": { + "description": "Calculate the duties and tariffs for cross border shipments.", + "type": "boolean" + }, + "carrier_ids": { + "description": "Array of carrier ids to get rates for", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier ids" + }, + "minItems": 1, + "type": "array" + }, + "is_return": { + "description": "Indicate if it's a return shipment", + "type": "boolean" + }, + "package_types": { + "items": { + "minLength": 1, + "type": "string" + }, + "type": "array" + }, + "preferred_currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + }, + "rate_type": { + "description": "Indicates what type of rating to perform", + "enum": [ + "check", + "shipment", + "quick" + ], + "type": "string" + }, + "service_codes": { + "items": { + "description": "Item Service Codes", + "minLength": 1, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "carrier_ids" + ], + "title": "rate_request_body", + "type": "object" + } + ], + "description": "The rate options" + } + }, + "title": "rate_request_rate_options", + "type": "object" + } + ], + "description": "A rate shipments request body", + "oneOf": [ + { + "properties": { + "shipment_ids": { + "description": "The array of shipment IDs", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "shipment ids" + }, + "type": "array" + } + }, + "required": [ + "shipment_ids" + ], + "title": "rate_request_by_shipment_ids", + "type": "object" + }, + { + "properties": { + "shipments": { + "description": "The array of shipments to get bulk rate estimates for", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ], + "description": "The shipment to get a bulk rate estimate for" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "shipments" + ], + "title": "rate_request_by_shipments", + "type": "object" + } + ], + "properties": { + "ship_from_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + }, + "ship_to_service_point_id": { + "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.", + "example": "614940", + "nullable": true, + "type": "string" + } + }, + "required": [ + "rate_options" + ], + "title": "compare_bulk_rates_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "A bulk rate response body", + "items": { + "additionalProperties": false, + "description": "A bulk rate", + "properties": { + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "An array of errors that were returned while retrieving the bulk rate", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ], + "description": "An error that occurred while retrieving the bulk rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "rate_request_id", + "shipment_id", + "created_at", + "status", + "errors" + ], + "title": "bulk_rate", + "type": "object" + }, + "title": "compare_bulk_rates_response_body", + "type": "array" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Bulk Rates", + "tags": [ + "rates" + ] + }, + "summary": "Bulk Rates" + }, + "/v1/rates/estimate": { + "description": "Show rate estimations between carriers with basic information.", + "post": { + "description": "Get Rate Estimates", + "operationId": "estimate_rates", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ] + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ] + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The dimensions of the package" + }, + "from_city_locality": { + "description": "from postal code", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "from_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "from_postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "from_state_province": { + "description": "From state province", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "ship date", + "type": "string" + }, + "to_city_locality": { + "description": "The city locality the package is being shipped to", + "example": "Austin", + "minLength": 1, + "type": "string" + }, + "to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "to_postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "to_state_province": { + "description": "To state province", + "example": "Houston", + "minLength": 1, + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the package" + } + }, + "title": "rate_estimate_options", + "type": "object" + } + ], + "description": "A rate estimate request body", + "oneOf": [ + { + "properties": { + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "deprecated": true, + "description": "A string that uniquely identifies the carrier" + } + }, + "title": "rate_estimate_by_carrier_id", + "type": "object" + }, + { + "properties": { + "carrier_ids": { + "description": "Array of Carrier Ids", + "items": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "carrier id", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "title": "rate_estimate_by_carrier_ids", + "type": "object" + } + ], + "required": [ + "from_country_code", + "from_postal_code", + "from_city_locality", + "from_state_province", + "to_country_code", + "to_postal_code", + "to_city_locality", + "to_state_province", + "weight", + "ship_date" + ], + "title": "estimate_rates_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "A rate estimate response body", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate estimate", + "properties": { + "carrier_code": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate_estimate", + "type": "object" + } + ] + }, + "title": "estimate_rates_response_body", + "type": "array" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Estimate Rates", + "tags": [ + "rates" + ] + }, + "summary": "Rate Estimates" + }, + "/v1/rates/{rate_id}": { + "description": "Get Individual rate information.", + "get": { + "description": "Retrieve a previously queried rate by its ID", + "operationId": "get_rate_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "A rate response body", + "required": [ + "rates", + "invalid_rates", + "rate_request_id", + "shipment_id", + "created_at", + "status", + "errors" + ], + "title": "get_rate_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Rate By ID", + "tags": [ + "rates" + ] + }, + "parameters": [ + { + "description": "Rate ID", + "in": "path", + "name": "rate_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Rate" + }, + "/v1/service_points/list": { + "post": { + "description": "List carrier service points by location", + "operationId": "service_points_list", + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "description": "A get service points request body. Caller must provide exactly one of address_query, address, or lat / long pair.", + "properties": { + "address": { + "description": "Structured address to search by.", + "properties": { + "address_line1": { + "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.", + "example": "1999 Bishop Grandin Blvd.", + "type": "string" + }, + "address_line2": { + "type": "string" + }, + "address_line3": { + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ], + "type": "string" + }, + "state_province": { + "description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.", + "type": "string" + } + }, + "required": [ + "country_code" + ], + "type": "object" + }, + "address_query": { + "description": "Unstructured text to search for service points by.", + "example": "177A Bleecker Street New York", + "type": "string" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.874518928233094, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 2.3591775711639404, + "format": "double", + "type": "number" + }, + "max_results": { + "description": "The maximum number of service points to return", + "example": 25, + "format": "int32", + "type": "integer" + }, + "providers": { + "description": "An array of shipping service providers and service codes", + "items": { + "properties": { + "carrier_id": { + "description": "Uniquely identifies a carrier connection", + "example": "se-123456", + "type": "string" + }, + "service_code": { + "items": { + "description": "Uniquely identifies a shipping service", + "example": "chronoclassic", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "radius": { + "description": "Search radius in kilometers", + "example": 500, + "format": "int32", + "type": "integer" + }, + "shipment": { + "description": "Shipment information to be used for service point selection", + "properties": { + "packages": { + "description": "An array of package dimensions", + "items": { + "properties": { + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + } + }, + "type": "object" + }, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "Shipment total weight" + } + }, + "type": "object" + } + }, + "required": [ + "providers" + ], + "title": "get_service_points_request_body", + "type": "object" + } + ], + "title": "get_service_points_request" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "A list service points response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.842608, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 0.032875, + "format": "double", + "type": "number" + }, + "service_points": { + "items": { + "properties": { + "address_line1": { + "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.", + "example": "PLACE DU CANADA", + "type": "string" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "TRUN", + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.", + "example": "My fancy company name", + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "distance_in_meters": { + "description": "Distance in meters", + "example": 728.9959308847579, + "format": "double", + "type": "number" + }, + "features": { + "description": "Service features", + "items": { + "enum": [ + "drop_off_point", + "pickup_point", + "print_services", + "after_hours_locker", + "after_hours_dropbox" + ], + "type": "string" + }, + "type": "array" + }, + "hours_of_operation": { + "description": "Hours of operation", + "properties": { + "friday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "monday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "saturday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "sunday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "thursday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tuesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "wednesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.842608, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 0.032875, + "format": "double", + "type": "number" + }, + "phone_number": { + "description": "Phone number associated", + "example": "555-555-5555", + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "service_codes": { + "items": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) service code.", + "example": "chronoclassic", + "type": "string" + }, + "type": "array" + }, + "service_point_id": { + "description": "A unique identifier for a carrier drop off point.", + "example": "614940", + "type": "string" + }, + "state_province": { + "description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.", + "example": "TRUN", + "type": "string" + }, + "type": { + "default": "pudo", + "description": "Service point type", + "enum": [ + "pudo", + "locker" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "title": "list_service_points_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Service Points", + "tags": [ + "service_points" + ] + }, + "summary": "Service Points" + }, + "/v1/service_points/{carrier_code}/{country_code}/{service_point_id}": { + "get": { + "description": "Returns a carrier service point by using the service_point_id", + "operationId": "service_points_get_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "A get service point by ID response body", + "properties": { + "service_point": { + "properties": { + "address_line1": { + "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.", + "example": "PLACE DU CANADA", + "type": "string" + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "TRUN", + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.", + "example": "My fancy company name", + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "features": { + "description": "Service features", + "items": { + "enum": [ + "drop_off_point", + "pickup_point", + "print_services", + "after_hours_locker", + "after_hours_dropbox" + ], + "type": "string" + }, + "type": "array" + }, + "hours_of_operation": { + "description": "Hours of operation", + "properties": { + "friday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "monday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "saturday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "sunday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "thursday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tuesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "wednesday": { + "items": { + "properties": { + "close": { + "description": "Closing time", + "example": "12:00", + "type": "string" + }, + "open": { + "description": "Opening time", + "example": "09:15", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "lat": { + "description": "The latitude of the point. Represented as signed degrees. Required if long is provided. http://www.geomidpoint.com/latlon.html", + "example": 48.842608, + "format": "double", + "type": "number" + }, + "long": { + "description": "The longitude of the point. Represented as signed degrees. Required if lat is provided. http://www.geomidpoint.com/latlon.html", + "example": 0.032875, + "format": "double", + "type": "number" + }, + "phone_number": { + "description": "Phone number associated", + "example": "555-555-5555", + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "service_codes": { + "items": { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) service code.", + "type": "string" + }, + "type": "array" + }, + "service_point_id": { + "description": "A unique identifier for a carrier drop off point.", + "example": "614940", + "type": "string" + }, + "state_province": { + "description": "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.", + "example": "TRUN", + "type": "string" + }, + "type": { + "default": "pudo", + "description": "Service point type", + "enum": [ + "pudo", + "locker" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "title": "get_service_point_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Service Point By ID", + "tags": [ + "service_points" + ] + }, + "parameters": [ + { + "description": "Carrier code", + "example": "stamps_com", + "in": "path", + "name": "carrier_code", + "required": true, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "in": "path", + "name": "country_code", + "required": true, + "schema": { + "maxLength": 2, + "minLength": 2, + "type": "string" + } + }, + { + "example": "614940", + "in": "path", + "name": "service_point_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "Service Points" + }, + "/v1/shipments": { + "description": "Shipments are the gatekeeper to more advanced functionality inside ShipEngine. When you create a shipment, we respond with a shipment_id that is a unique identifier inside of ShipEngine.\nAdditionally, we realize that you may have your own identifier, you can set this by setting the `external_shipment_id` field in the request body.\n", + "get": { + "description": "Get list of Shipments", + "operationId": "list_shipments", + "parameters": [ + { + "in": "query", + "name": "shipment_status", + "required": false, + "schema": { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + }, + { + "description": "Batch ID", + "in": "query", + "name": "batch_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "description": "Search for shipments based on the custom tag added to the shipment object", + "example": "Letters_to_santa", + "in": "query", + "name": "tag", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "modified_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "modified_at_end", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "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", + "example": 2, + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 1, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "The number of results to return per response.", + "example": 50, + "in": "query", + "name": "page_size", + "required": false, + "schema": { + "default": 25, + "format": "int32", + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Sales Order ID", + "in": "query", + "name": "sales_order_id", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Controls the sort order of the query.", + "in": "query", + "name": "sort_dir", + "required": false, + "schema": { + "allOf": [ + { + "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", + "enum": [ + "asc", + "desc" + ], + "title": "sort_dir", + "type": "string" + } + ], + "default": "desc" + } + }, + { + "example": "modified_at", + "in": "query", + "name": "sort_by", + "required": false, + "schema": { + "description": "The possible shipments sort by values", + "enum": [ + "modified_at", + "created_at" + ], + "title": "shipments_sort_by", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A list shipment response body", + "properties": { + "links": { + "allOf": [ + { + "additionalProperties": false, + "description": "Helpful links to other pages of results", + "properties": { + "first": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the first page of results. This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.\n" + }, + "last": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "A link to a related resource", + "required": [ + "href" + ], + "title": "link", + "type": "object" + } + ], + "description": "The link to the final page of results. This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.\n" + }, + "next": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the next page of results. The `href` field will only be set when the `page` is less than `pages`.\n" + }, + "prev": { + "allOf": [ + { + "additionalProperties": false, + "description": "A link to a related resource, or an empty object if there is no resource to link to", + "properties": { + "href": { + "allOf": [ + { + "description": "A URL", + "example": "http://api.shipengine.com/v1/labels/se-28529731", + "format": "url", + "minLength": 1, + "title": "url", + "type": "string" + } + ], + "description": "The URL of the linked resource, if any" + }, + "type": { + "description": "The type of resource, or the type of relationship to the parent resource", + "minLength": 1, + "type": "string" + } + }, + "title": "optional_link", + "type": "object" + } + ], + "description": "The link to the previous page of results. The `href` field will only be set when the `page` is 2 or greater.\n" + } + }, + "required": [ + "first", + "last", + "prev", + "next" + ], + "title": "pagination_link", + "type": "object" + } + ], + "readOnly": true + }, + "page": { + "example": "????", + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "pages": { + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "shipments": { + "description": "The list of shipments returned by the api call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "A shipment object", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "total": { + "description": "Total number of shipments returned by the api call", + "example": 1990, + "format": "int64", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "shipments", + "total", + "page", + "pages", + "links" + ], + "title": "list_shipments_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Shipments", + "tags": [ + "shipments" + ] + }, + "post": { + "description": "Create one or multiple shipments.", + "operationId": "create_shipments", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A create shipments request body", + "properties": { + "shipments": { + "description": "An array of shipments to be created.", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "validate_shipment_fields", + "type": "object" + }, + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "An address validating shipment", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_to", + "ship_from" + ], + "title": "address_validating_shipment", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "shipments" + ], + "title": "create_shipments_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A create shipments response body", + "properties": { + "has_errors": { + "default": false, + "description": "Indicates if errors occured while creating the shipments", + "type": "boolean" + }, + "shipments": { + "description": "An array of shipments that were created.", + "items": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "properties": { + "address_validation": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation" + }, + "errors": { + "deprecated": true, + "description": "An array of errors that occurred while creating shipment.", + "items": { + "description": "An error that occurred while creating a shipment.", + "example": "Parameter value '100000000.00' is out of range.", + "minLength": 1, + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "title": "create_shipment_response_body_fields", + "type": "object" + } + ], + "description": "A create and validate shipment resource", + "title": "create_and_validate_shipment", + "type": "object" + } + ], + "description": "The shipment that was created." + }, + "type": "array" + } + }, + "required": [ + "has_errors", + "shipments" + ], + "title": "create_shipments_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create Shipments", + "tags": [ + "shipments" + ] + }, + "summary": "Shipments" + }, + "/v1/shipments/external_shipment_id/{external_shipment_id}": { + "description": "When a shipment object is created with a custom shipment ID, you can query it using this endpoint\n", + "get": { + "description": "Query Shipments created using your own custom ID convention using this endpint", + "operationId": "get_shipment_by_external_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "A get shipment by external id response body", + "title": "get_shipment_by_external_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Shipment By External ID", + "tags": [ + "shipments" + ] + }, + "parameters": [ + { + "example": "0bcb569d-1727-4ff9-ab49-b2fec0cee5ae", + "in": "path", + "name": "external_shipment_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "summary": "External Shipment ID" + }, + "/v1/shipments/recognize": { + "description": "Data 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 shipping data (people's names, addresses, package weights and dimensions, insurance and delivery requirements, etc.) from this unstructured text.\n", + "put": { + "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", + "operationId": "parse_shipment", + "requestBody": { + "content": { + "application/json": { + "examples": { + "some_known_fields": { + "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", + "summary": "Some known fields", + "value": { + "shipment": { + "service_code": "usps_first_class_mail", + "ship_from": { + "address_line1": "587 Shotwell St.", + "address_line2": "Suite 201", + "address_residential_indicator": "yes", + "city_locality": "San Francisco", + "company_name": "My Awesome Store", + "country_code": "US", + "phone": "555-555-5555", + "postal_code": "94110", + "state_province": "CA" + } + }, + "text": "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" + } + }, + "text_only": { + "description": "This is the simplest way to call the shipment-recognition API. Just pass the text to be parsed and nothing else.\n", + "summary": "Text only", + "value": { + "text": "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" + } + } + }, + "schema": { + "additionalProperties": false, + "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", + "properties": { + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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" + }, + "text": { + "description": "The unstructured text that contains shipping-related entities", + "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", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "text" + ], + "title": "parse_shipment_request_body", + "type": "object" + } + } + }, + "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", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "some_known_fields": { + "description": "This response is shows that the shipment-recognition API was able to recognize all the shipping entities in the text. Notice that the `ship_from` and `service_code` fields are populated with the values that were provided in the request.\n", + "value": { + "entities": [ + { + "end_index": 11, + "result": { + "unit": "ounce", + "value": 4 + }, + "score": 0.9805313966503588, + "start_index": 9, + "text": "4oz", + "type": "weight" + }, + { + "end_index": 36, + "result": { + "height": 14, + "length": 5, + "unit": "inch", + "width": 10 + }, + "score": 1, + "start_index": 28, + "text": "5x10x14in", + "type": "dimensions" + }, + { + "end_index": 36, + "result": { + "unit": "inch", + "value": 14 + }, + "score": 0.9805313966503588, + "start_index": 33, + "text": "14in", + "type": "dimension" + }, + { + "end_index": 196, + "result": { + "address_line1": "3800 North Lamar", + "address_line2": "Suite 200", + "city_locality": "Austin", + "company_name": "Adult Signature", + "direction": "to", + "name": "Margie McMiller", + "postal_code": "78652", + "state_province": "TX" + }, + "score": 0.9281558837267101, + "start_index": 61, + "text": "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", + "type": "address" + }, + { + "end_index": 78, + "result": { + "value": "Margie McMiller" + }, + "score": 0.9519646137063122, + "start_index": 64, + "text": "Margie McMiller", + "type": "person" + }, + { + "end_index": 98, + "result": { + "line": 1, + "value": "3800 North Lamar" + }, + "score": 0.9805313966503588, + "start_index": 83, + "text": "3800 North Lamar", + "type": "address_line" + }, + { + "end_index": 86, + "result": { + "type": "cardinal", + "value": 3800 + }, + "score": 0.9805313966503588, + "start_index": 83, + "text": 3800, + "type": "number" + }, + { + "end_index": 108, + "result": { + "line": 2, + "value": "Suite 200" + }, + "score": 1, + "start_index": 100, + "text": "suite 200", + "type": "address_line" + }, + { + "end_index": 111, + "result": { + "unit": "inch", + "value": 200 + }, + "score": 0.4792571878834418, + "start_index": 106, + "text": "200 in", + "type": "dimension" + }, + { + "end_index": 118, + "result": { + "value": "Austin" + }, + "score": 0.9805313966503588, + "start_index": 113, + "text": "austin", + "type": "city_locality" + }, + { + "end_index": 122, + "result": { + "name": "Texas", + "value": "TX" + }, + "score": 0.6082904353940255, + "start_index": 121, + "text": "tx", + "type": "state_province" + }, + { + "end_index": 128, + "result": { + "value": 78652 + }, + "score": 0.9519646137063122, + "start_index": 124, + "text": 78652, + "type": "postal_code" + }, + { + "end_index": 153, + "result": { + "name": "Stamps.com", + "value": "se-118608" + }, + "score": 0.9519646137063122, + "start_index": 150, + "text": "USPS", + "type": "carrier" + }, + { + "end_index": 165, + "result": { + "name": "USPS First Class Mail", + "value": "usps_first_class_mail" + }, + "score": 0.6082904353940255, + "start_index": 155, + "text": "first class", + "type": "service" + }, + { + "end_index": 159, + "result": { + "type": "ordinal", + "value": 1 + }, + "score": 0.9805313966503588, + "start_index": 155, + "text": "first", + "type": "number" + }, + { + "end_index": 196, + "result": { + "value": "Adult Signature" + }, + "score": 0.9519646137063122, + "start_index": 182, + "text": "adult signature", + "type": "company" + }, + { + "end_index": 196, + "result": { + "name": "Adult Signature", + "value": "adult_signature" + }, + "score": 0.8530163983409642, + "start_index": 182, + "text": "adult signature", + "type": "delivery_confirmation" + }, + { + "end_index": 234, + "result": { + "unit": "USD", + "value": 400 + }, + "score": 0.8530163983409642, + "start_index": 219, + "text": "insured for $400", + "type": "insurance" + }, + { + "end_index": 234, + "result": { + "unit": "USD", + "value": 400 + }, + "score": 1, + "start_index": 231, + "text": "$400", + "type": "insured_value" + } + ], + "score": 0.9031369611169101, + "shipment": { + "carrier_id": "se-118608", + "confirmation": "adult_signature", + "packages": [ + { + "dimensions": { + "height": 14, + "length": 5, + "unit": "inch", + "width": 10 + }, + "insured_value": { + "amount": 400, + "currency": "USD" + }, + "weight": { + "unit": "ounce", + "value": 4 + } + } + ], + "service_code": "usps_first_class_mail", + "ship_from": { + "address_line1": "587 Shotwell St.", + "address_line2": "Suite 201", + "address_residential_indicator": "yes", + "city_locality": "San Francisco", + "company_name": "My Awesome Store", + "country_code": "US", + "phone": "555-555-5555", + "postal_code": "94110", + "state_province": "CA" + }, + "ship_to": { + "address_line1": "3800 North Lamar", + "address_line2": "Suite 200", + "address_residential_indicator": "unknown", + "city_locality": "Austin", + "company_name": "Adult Signature", + "name": "Margie McMiller", + "postal_code": "78652", + "state_province": "TX" + } + } + } + }, + "text_only": { + "description": "This response shows that the shipment-recognition API was able to recognize all the shipping entities in the text. Notice that the `ship_from` field is not populated, since it wasn't included in the request or in the parsed text.\n", + "value": { + "entities": [ + { + "end_index": 11, + "result": { + "unit": "ounce", + "value": 4 + }, + "score": 0.9805313966503588, + "start_index": 9, + "text": "4oz", + "type": "weight" + }, + { + "end_index": 36, + "result": { + "height": 14, + "length": 5, + "unit": "inch", + "width": 10 + }, + "score": 1, + "start_index": 28, + "text": "5x10x14in", + "type": "dimensions" + }, + { + "end_index": 36, + "result": { + "unit": "inch", + "value": 14 + }, + "score": 0.9805313966503588, + "start_index": 33, + "text": "14in", + "type": "dimension" + }, + { + "end_index": 196, + "result": { + "address_line1": "3800 North Lamar", + "address_line2": "Suite 200", + "city_locality": "Austin", + "company_name": "Adult Signature", + "direction": "to", + "name": "Margie McMiller", + "postal_code": "78652", + "state_province": "TX" + }, + "score": 0.9281558837267101, + "start_index": 61, + "text": "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", + "type": "address" + }, + { + "end_index": 78, + "result": { + "value": "Margie McMiller" + }, + "score": 0.9519646137063122, + "start_index": 64, + "text": "Margie McMiller", + "type": "person" + }, + { + "end_index": 98, + "result": { + "line": 1, + "value": "3800 North Lamar" + }, + "score": 0.9805313966503588, + "start_index": 83, + "text": "3800 North Lamar", + "type": "address_line" + }, + { + "end_index": 86, + "result": { + "type": "cardinal", + "value": 3800 + }, + "score": 0.9805313966503588, + "start_index": 83, + "text": 3800, + "type": "number" + }, + { + "end_index": 108, + "result": { + "line": 2, + "value": "Suite 200" + }, + "score": 1, + "start_index": 100, + "text": "suite 200", + "type": "address_line" + }, + { + "end_index": 111, + "result": { + "unit": "inch", + "value": 200 + }, + "score": 0.4792571878834418, + "start_index": 106, + "text": "200 in", + "type": "dimension" + }, + { + "end_index": 118, + "result": { + "value": "Austin" + }, + "score": 0.9805313966503588, + "start_index": 113, + "text": "austin", + "type": "city_locality" + }, + { + "end_index": 122, + "result": { + "name": "Texas", + "value": "TX" + }, + "score": 0.6082904353940255, + "start_index": 121, + "text": "tx", + "type": "state_province" + }, + { + "end_index": 128, + "result": { + "value": 78652 + }, + "score": 0.9519646137063122, + "start_index": 124, + "text": 78652, + "type": "postal_code" + }, + { + "end_index": 153, + "result": { + "name": "Stamps.com", + "value": "se-118608" + }, + "score": 0.9519646137063122, + "start_index": 150, + "text": "USPS", + "type": "carrier" + }, + { + "end_index": 165, + "result": { + "name": "USPS First Class Mail", + "value": "usps_first_class_mail" + }, + "score": 0.6082904353940255, + "start_index": 155, + "text": "first class", + "type": "service" + }, + { + "end_index": 159, + "result": { + "type": "ordinal", + "value": 1 + }, + "score": 0.9805313966503588, + "start_index": 155, + "text": "first", + "type": "number" + }, + { + "end_index": 196, + "result": { + "value": "Adult Signature" + }, + "score": 0.9519646137063122, + "start_index": 182, + "text": "adult signature", + "type": "company" + }, + { + "end_index": 196, + "result": { + "name": "Adult Signature", + "value": "adult_signature" + }, + "score": 0.8530163983409642, + "start_index": 182, + "text": "adult signature", + "type": "delivery_confirmation" + }, + { + "end_index": 234, + "result": { + "unit": "USD", + "value": 400 + }, + "score": 0.8530163983409642, + "start_index": 219, + "text": "insured for $400", + "type": "insurance" + }, + { + "end_index": 234, + "result": { + "unit": "USD", + "value": 400 + }, + "score": 1, + "start_index": 231, + "text": "$400", + "type": "insured_value" + } + ], + "score": 0.9031369611169101, + "shipment": { + "carrier_id": "se-118608", + "confirmation": "adult_signature", + "packages": [ + { + "dimensions": { + "height": 14, + "length": 5, + "unit": "inch", + "width": 10 + }, + "insured_value": { + "amount": 400, + "currency": "USD" + }, + "weight": { + "unit": "ounce", + "value": 4 + } + } + ], + "service_code": "usps_first_class_mail", + "ship_to": { + "address_line1": "3800 North Lamar", + "address_line2": "Suite 200", + "address_residential_indicator": "unknown", + "city_locality": "Austin", + "company_name": "Adult Signature", + "name": "Margie McMiller", + "postal_code": "78652", + "state_province": "TX" + } + } + } + } + }, + "schema": { + "additionalProperties": false, + "description": "The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.\n", + "properties": { + "entities": { + "description": "All of the entities that were recognized in the text. An \"entity\" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value.\n", + "items": { + "additionalProperties": false, + "description": "An entity is a single piece of data that was recognized in unstructured text. For example, a city, a postal code, package dimensions, insured value, etc. Each entity includes the original text and the parsed value.\n", + "properties": { + "end_index": { + "description": "The index of the last character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "result": { + "additionalProperties": true, + "description": "The normalized value of the entity.\n\nMost entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\".\n\nSome entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`.\n", + "properties": {}, + "title": "normalized_entity", + "type": "object" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "start_index": { + "description": "The index of the first character of this entity within the original text", + "minimum": 0, + "type": "integer" + }, + "text": { + "description": "The substring from the original text that was recognized as this entity", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.)", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type", + "score", + "text", + "start_index", + "end_index" + ], + "title": "recognized_entity", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "score": { + "description": "A confidence score between zero and one that indicates how certain the API is that it understood the text.\n", + "format": "double", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "shipment": { + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "description": "The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity.\n\n> **Note:** The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](https://www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct.\n" + } + }, + "required": [ + "score", + "shipment", + "entities" + ], + "title": "parse_shipment_response_body", + "type": "object" + } + } + }, + "description": "Returns the parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.\n" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Parse shipping info", + "tags": [ + "shipments" + ] + }, + "summary": "Parse shipping info" + }, + "/v1/shipments/tags": { + "description": "Tags associated with the shipment object to be used to organize and query shipment items.\n", + "put": { + "description": "Update Shipments Tags", + "operationId": "shipments_update_tags", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "example": { + "shipments_tags": [ + { + "shipment_id": "se-1014296", + "tags": [ + "Fragile", + "International" + ] + }, + { + "shipment_id": "se-1014297", + "tags": [ + "Fragile", + "International" + ] + } + ] + }, + "properties": { + "shipments_tags": { + "items": { + "properties": { + "shipment_id": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "title": "update_shipments_tags", + "type": "object" + } + ], + "description": "A request body with shipments and tags", + "title": "update_shipments_tags_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "NoContent" + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Shipments Tags", + "tags": [ + "shipments" + ] + }, + "summary": "Shipment Tags" + }, + "/v1/shipments/{shipment_id}": { + "description": "Retrieve and Update and individual shipment based on its ID", + "get": { + "description": "Get an individual shipment based on its ID", + "operationId": "get_shipment_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + } + ], + "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", + "required": [ + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "modified_at", + "shipment_status", + "ship_to", + "ship_from", + "warehouse_id", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "shipment", + "type": "object" + } + ], + "description": "A get shipment by id response body", + "title": "get_shipment_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Shipment By ID", + "tags": [ + "shipments" + ] + }, + "parameters": [ + { + "description": "Shipment ID", + "in": "path", + "name": "shipment_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Update a shipment object based on its ID", + "operationId": "update_shipment", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "properties": { + "validate_address": { + "allOf": [ + { + "description": "The possible validate address values", + "enum": [ + "no_validation", + "validate_only", + "validate_and_clean" + ], + "title": "validate_address", + "type": "string" + } + ], + "default": "no_validation" + } + }, + "title": "update_shipment_fields", + "type": "object" + } + ], + "description": "An update shipment request body", + "required": [ + "ship_to", + "ship_from" + ], + "title": "update_shipment_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.\n", + "properties": { + "advanced_options": { + "allOf": [ + { + "additionalProperties": true, + "description": "Advanced shipment options", + "properties": { + "additional_handling": { + "default": null, + "description": "Indicate to the carrier that this shipment requires additional handling.\n", + "nullable": true, + "type": "boolean" + }, + "bill_to_account": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "bill_to_country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_party": { + "allOf": [ + { + "description": "The possible bill to party values", + "enum": [ + "recipient", + "third_party" + ], + "title": "bill_to_party", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "bill_to_postal_code": { + "default": null, + "description": "The postal code of the third-party that is responsible for shipping costs.\n", + "nullable": true, + "type": "string" + }, + "certificate_number": { + "default": null, + "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.", + "example": 784515, + "nullable": true, + "type": "string" + }, + "collect_on_delivery": { + "description": "Defer payment until package is delivered, instead of when it is ordered.", + "properties": { + "payment_amount": { + "properties": { + "amount": { + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "title": "payment_amount", + "type": "object" + }, + "payment_type": { + "allOf": [ + { + "description": "Types of payment that are supported", + "enum": [ + "any", + "cash", + "cash_equivalent", + "none" + ], + "title": "collect_on_delivery_payment_type", + "type": "string" + } + ] + } + }, + "title": "collect_on_delivery", + "type": "object" + }, + "contains_alcohol": { + "default": false, + "description": "Indicates that the shipment contains alcohol.", + "type": "boolean" + }, + "custom_field1": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field2": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "custom_field3": { + "default": null, + "description": "An arbitrary field that can be used to store information about the shipment.\n", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "dangerous_goods": { + "default": false, + "description": "Indicates if the Dangerous goods are present in the shipment", + "type": "boolean" + }, + "dangerous_goods_contact": { + "description": "Contact information for Dangerous goods", + "properties": { + "name": { + "description": "Name of the contact", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact", + "type": "string" + } + }, + "type": "object" + }, + "delivered_duty_paid": { + "default": false, + "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", + "type": "boolean" + }, + "delivery-as-addressed": { + "default": false, + "description": "Instructs the carrier to deliver the package only to the exact address provided.", + "type": "boolean" + }, + "dry_ice": { + "default": false, + "description": "Indicates if the shipment contain dry ice", + "type": "boolean" + }, + "dry_ice_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The weight of the dry ice in the shipment", + "nullable": true + }, + "fedex_freight": { + "description": "Provide details for the Fedex freight service", + "properties": { + "booking_confirmation": { + "type": "string" + }, + "shipper_load_and_count": { + "type": "string" + } + }, + "type": "object" + }, + "fragile": { + "default": false, + "description": "Indicates that the contents of the package are fragile and should be handled with care.", + "type": "boolean" + }, + "freight_class": { + "default": null, + "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", + "example": 77.5, + "nullable": true, + "type": "string" + }, + "invoice_number": { + "default": null, + "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.", + "example": "IOC56888", + "nullable": true, + "type": "string" + }, + "license_number": { + "default": null, + "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.", + "example": 514785, + "nullable": true, + "type": "string" + }, + "non_machinable": { + "default": false, + "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", + "type": "boolean" + }, + "origin_type": { + "allOf": [ + { + "description": "Indicates if the package will be picked up or dropped off by the carrier", + "enum": [ + "pickup", + "drop_off" + ], + "title": "origin_type", + "type": "string" + } + ], + "default": null, + "nullable": true + }, + "regulated_content_type": { + "allOf": [ + { + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "enum": [ + "day_old_poultry", + "other_live_animal" + ], + "title": "regulated_content_type", + "type": "string" + } + ], + "default": null, + "description": "Indicates the category of goods in the shipment that is subject to special regulatory or compliance requirements.", + "nullable": true + }, + "return-after-first-attempt": { + "default": false, + "description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails.", + "type": "boolean" + }, + "saturday_delivery": { + "default": false, + "description": "Enables Saturday delivery, if supported by the carrier.", + "type": "boolean" + }, + "shipper_release": { + "default": null, + "nullable": true, + "type": "boolean" + }, + "third_party_consignee": { + "default": false, + "description": "Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached", + "type": "boolean" + }, + "use_ups_ground_freight_pricing": { + "default": null, + "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", + "nullable": true, + "type": "boolean" + }, + "windsor_framework_details": { + "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.", + "properties": { + "movement_indicator": { + "description": "An indicator that will tell the carrier and HMRC the type of movement for the shipment.", + "enum": [ + "c2c", + "b2c", + "c2b", + "b2b" + ], + "type": "string" + }, + "not_at_risk": { + "description": "An indicator that allows a shipper to declare the shipment as not-at-risk.", + "type": "boolean" + } + }, + "type": "object" + } + }, + "title": "advanced_shipment_options", + "type": "object" + } + ], + "description": "Advanced shipment options. These are entirely optional." + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "The carrier account that is billed for the shipping charges" + }, + "comparison_rate_type": { + "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.", + "example": "retail", + "nullable": true, + "type": "string" + }, + "confirmation": { + "allOf": [ + { + "description": "The possible delivery confirmation values", + "enum": [ + "none", + "delivery", + "signature", + "adult_signature", + "direct_signature", + "delivery_mailed", + "verbal_confirmation", + "delivery_code", + "age_verification_16_plus" + ], + "title": "delivery_confirmation", + "type": "string" + } + ], + "default": "none", + "description": "The type of delivery confirmation that is required for this shipment." + }, + "created_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created in ShipEngine.", + "readOnly": true + }, + "customs": { + "allOf": [ + { + "additionalProperties": false, + "description": "Options for international shipments, such as customs declarations.", + "properties": { + "certificate_number": { + "description": "The certificate number to be used in the customs.", + "type": "string" + }, + "contents": { + "allOf": [ + { + "description": "The possible package contents values", + "enum": [ + "merchandise", + "documents", + "gift", + "returned_goods", + "sample", + "other" + ], + "title": "package_contents", + "type": "string" + } + ], + "default": "merchandise", + "description": "The type of contents in this shipment. This may impact import duties or customs treatment." + }, + "contents_explanation": { + "description": "Explanation for contents (required if the `contents` is provided as `other`)", + "type": "string" + }, + "customs_items": { + "default": [], + "deprecated": true, + "description": "Customs declarations for each item in the shipment. (Please provide this information under `products` inside `packages`)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "customs_item_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the customs item", + "readOnly": true + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the customs item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "value_currency": { + "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", + "type": "string" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "required": [ + "customs_item_id" + ], + "title": "customs_item", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "declaration": { + "description": "Declaration statement to be placed on the commercial invoice", + "type": "string" + }, + "importer_of_record": { + "allOf": [ + { + "description": "importer of records address, anywhere in the world.\n", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "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", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of a contact person at this address. Either `name` or the `company_name` field should always be set.\n", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "address_line1", + "city_locality", + "postal_code", + "country_code" + ], + "title": "importer_of_records", + "type": "object" + } + ], + "type": "object" + }, + "invoice_additional_details": { + "allOf": [ + { + "description": "The additional information to put on commercial invoice \n", + "properties": { + "discount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Discount for shipment." + }, + "estimated_import_charges": { + "allOf": [ + { + "additionalProperties": false, + "description": "Estimated import charges for commercial invoices for international shipments.\n", + "properties": { + "duties": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import duties." + }, + "taxes": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Estimated import taxes." + } + }, + "title": "estimated_import_charges", + "type": "object" + } + ], + "description": "Estimated import charges for commercial invoices for international shipments." + }, + "freight_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Freight Charge for shipment." + }, + "insurance_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Insurance Charge for shipment." + }, + "invoice_number": { + "description": "The invoice number to be used in the customs.", + "type": "string" + }, + "other_charge": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Other charge for shipment." + }, + "other_charge_description": { + "description": "Description for the other charge (if provided).", + "type": "string" + } + }, + "title": "invoice_additional_details", + "type": "object" + } + ], + "type": "object" + }, + "license_number": { + "description": "The license number to be used in the customs.", + "type": "string" + }, + "non_delivery": { + "allOf": [ + { + "description": "The possible non delivery values", + "enum": [ + "return_to_sender", + "treat_as_abandoned" + ], + "title": "non_delivery", + "type": "string" + } + ], + "default": "return_to_sender", + "description": "Indicates what to do if a package is unable to be delivered." + }, + "terms_of_trade_code": { + "allOf": [ + { + "enum": [ + "exw", + "fca", + "cpt", + "cip", + "dpu", + "dap", + "ddp", + "fas", + "fob", + "cfr", + "cif", + "ddu", + "daf", + "deq", + "des" + ], + "title": "Allowed incoterms", + "type": "string" + } + ], + "description": "Specifies the supported terms of trade code (incoterms)", + "type": "string" + } + }, + "required": [ + "contents", + "non_delivery" + ], + "title": "international_shipment_options", + "type": "object" + } + ], + "default": null, + "description": "Customs information. This is usually only needed for international shipments.\n", + "nullable": true + }, + "external_order_id": { + "description": "ID that the Order Source assigned", + "nullable": true, + "type": "string" + }, + "external_shipment_id": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "insurance_provider": { + "allOf": [ + { + "description": "The possible insurance provider values", + "enum": [ + "none", + "shipsurance", + "carrier", + "third_party" + ], + "title": "insurance_provider", + "type": "string" + } + ], + "default": "none", + "description": "The insurance provider to use for any insured packages in the shipment.\n" + }, + "is_return": { + "default": false, + "description": "An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.\n", + "nullable": true, + "type": "boolean" + }, + "items": { + "default": [], + "description": "Describe the packages included in this shipment as related to potential metadata that was imported from\nexternal order sources\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A shipment item", + "properties": { + "asin": { + "description": "Amazon Standard Identification Number", + "example": "B00005N5PF", + "maxLength": 10, + "minLength": 10, + "nullable": true, + "type": "string" + }, + "bundle_sku": { + "description": "Item Stock Keeping Unit of the product bundle", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "external_order_id": { + "description": "external order id", + "nullable": true, + "type": "string" + }, + "external_order_item_id": { + "description": "external order item id", + "nullable": true, + "type": "string" + }, + "name": { + "description": "item name", + "minLength": 0, + "type": "string" + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "quantity": { + "description": "The quantity of this item included in the shipment", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sales_order_id": { + "description": "sales order id", + "nullable": true, + "type": "string" + }, + "sales_order_item_id": { + "description": "sales order item id", + "nullable": true, + "type": "string" + }, + "sku": { + "description": "Item Stock Keeping Unit", + "nullable": true, + "type": "string" + } + }, + "title": "shipment_item", + "type": "object" + } + ] + }, + "type": "array" + }, + "modified_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "The date and time that the shipment was created or last modified.", + "readOnly": true + }, + "order_source_code": { + "allOf": [ + { + "description": "The order sources that are supported by ShipEngine", + "enum": [ + "amazon_ca", + "amazon_us", + "brightpearl", + "channel_advisor", + "cratejoy", + "ebay", + "etsy", + "jane", + "groupon_goods", + "magento", + "paypal", + "seller_active", + "shopify", + "stitch_labs", + "squarespace", + "three_dcart", + "tophatter", + "walmart", + "woo_commerce", + "volusion" + ], + "title": "order_source_name", + "type": "string" + } + ] + }, + "packages": { + "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", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A package associated with a shipment\n", + "properties": { + "content_description": { + "description": "A short description of the package content. Required for shipments moving to, from, and through Mexico.\n", + "example": "Hand knitted wool socks", + "maxLength": 35, + "minLength": 1, + "nullable": true, + "type": "string" + }, + "dimensions": { + "allOf": [ + { + "additionalProperties": false, + "description": "The dimensions of a package", + "properties": { + "height": { + "default": 0, + "description": "The height of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "length": { + "default": 0, + "description": "The length of the package, in the specified unit", + "minimum": 0, + "type": "number" + }, + "unit": { + "allOf": [ + { + "description": "The dimension units that are supported by ShipEngine.", + "enum": [ + "inch", + "centimeter" + ], + "title": "dimension_unit", + "type": "string" + } + ], + "default": "inch" + }, + "width": { + "default": 0, + "description": "The width of the package, in the specified unit", + "minimum": 0, + "type": "number" + } + }, + "required": [ + "unit", + "length", + "width", + "height" + ], + "title": "dimensions", + "type": "object" + } + ], + "description": "The package dimensions" + }, + "external_package_id": { + "description": "An external package id.", + "minLength": 1, + "type": "string" + }, + "insured_value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "default": { + "amount": 0, + "currency": "USD" + }, + "description": "The insured value of the package. Requires the `insurance_provider` field of the shipment to be set.\n" + }, + "label_messages": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "reference1": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference2": { + "default": null, + "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", + "nullable": true, + "type": "string" + }, + "reference3": { + "default": null, + "description": "The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.\n", + "nullable": true, + "type": "string" + } + }, + "required": [ + "reference1", + "reference2", + "reference3" + ], + "title": "label_messages", + "type": "object" + } + ] + }, + "package_code": { + "allOf": [ + { + "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", + "example": "small_flat_rate_box", + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "package_code", + "type": "string" + } + ], + "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" + }, + "package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)" + }, + "package_name": { + "description": "The name of the of the [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/)", + "type": "string" + }, + "products": { + "default": [], + "description": "Details about products inside packages (Information provided would be used on custom documentation)", + "items": { + "additionalProperties": false, + "description": "The customs declaration for a single item in the shipment.", + "properties": { + "country_of_origin": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "default": null, + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) where this item originated\n", + "nullable": true + }, + "dangerous_goods": { + "default": [], + "description": "Details about dangerous goods inside products", + "items": { + "additionalProperties": false, + "description": "Dangerous goods attribute associated with the product\n", + "properties": { + "additional_description": { + "default": null, + "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier", + "nullable": true, + "type": "string" + }, + "dangerous_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "This model represents the amount of the dangerous goods..", + "properties": { + "amount": { + "default": 0, + "description": "The amount of dangerous goods.", + "minimum": 0, + "type": "number" + }, + "unit": { + "default": null, + "description": "The unit of dangerous goods.", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_amount", + "type": "object" + } + ], + "description": "This model represents the amount of the dangerous goods." + }, + "id_number": { + "default": null, + "description": "UN number to identify the dangerous goods.", + "nullable": true, + "type": "string" + }, + "packaging_group": { + "enum": [ + "i", + "ii", + "iii" + ], + "title": "packaging_group", + "type": "string" + }, + "packaging_instruction": { + "default": null, + "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.", + "nullable": true, + "type": "string" + }, + "packaging_instruction_section": { + "enum": [ + "section_1", + "section_2", + "section_1a", + "section_1b" + ], + "title": "packaging_instruction_section", + "type": "string" + }, + "packaging_type": { + "default": null, + "description": "The type of exterior packaging used to contain the dangerous good.", + "nullable": true, + "type": "string" + }, + "product_class": { + "default": null, + "description": "Dangerous goods product class based on regulation.", + "nullable": true, + "type": "string" + }, + "product_class_subsidiary": { + "default": null, + "description": "A secondary of product class for substances presenting more than one particular hazard", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "Quantity of dangerous goods.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "radioactive": { + "description": "Indication if the substance is radioactive.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "regulation_authority": { + "default": null, + "description": "Name of the regulatory authority.", + "nullable": true, + "type": "string" + }, + "regulation_level": { + "enum": [ + "lightly_regulated", + "fully_regulated", + "limited_quantities", + "excepted_quantity" + ], + "title": "regulation_level", + "type": "string" + }, + "reportable_quantity": { + "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "shipping_name": { + "default": null, + "description": "Trade description of the dangerous goods.", + "nullable": true, + "type": "string" + }, + "technical_name": { + "default": null, + "description": "Recognized Technical or chemical name of dangerous goods.", + "nullable": true, + "type": "string" + }, + "transport_category": { + "default": null, + "description": "Transport category assign to dangerous goods for the transport purpose.", + "nullable": true, + "type": "string" + }, + "transport_mean": { + "enum": [ + "ground", + "water", + "cargo_aircraft_only", + "passenger_aircraft" + ], + "title": "transport_mean", + "type": "string" + }, + "tunnel_code": { + "default": null, + "description": "Defines which types of tunnels the shipment is allowed to go through", + "nullable": true, + "type": "string" + } + }, + "title": "dangerous_goods", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "description": { + "default": null, + "description": "A description of the item", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "extended_details": { + "additionalProperties": true, + "description": "Additional details about products", + "type": "object" + }, + "harmonized_tariff_code": { + "default": null, + "description": "The [Harmonized Tariff Code](https://en.wikipedia.org/wiki/Harmonized_System) of this item.", + "example": 3926.1, + "nullable": true, + "type": "string" + }, + "mid_code": { + "description": "Manufacturers Identification code", + "nullable": true, + "type": "string" + }, + "product_url": { + "description": "link to the item on the seller website", + "nullable": true, + "type": "string" + }, + "quantity": { + "default": 0, + "description": "The quantity of this item in the shipment.", + "format": "int32", + "minimum": 0, + "type": "integer" + }, + "sku": { + "description": "The SKU (Stock Keeping Unit) of the item", + "nullable": true, + "type": "string" + }, + "sku_description": { + "description": "Description of the Custom Item's SKU", + "nullable": true, + "type": "string" + }, + "unit_of_measure": { + "nullable": true, + "type": "string" + }, + "value": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The declared value of each item" + }, + "vat_rate": { + "description": "VAT rate applicable to the item", + "example": 0.2, + "nullable": true, + "type": "number" + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The item weight" + } + }, + "title": "products", + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "shipment_package_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies this shipment package", + "readOnly": true + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ], + "description": "The tracking number for the package. The format depends on the carrier.\n", + "readOnly": true + }, + "weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The package weight" + } + }, + "required": [ + "weight" + ], + "title": "package", + "type": "object" + } + ] + }, + "minItems": 1, + "type": "array" + }, + "return_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "description": "The return address for this shipment. Defaults to the `ship_from` address.\n" + }, + "service_code": { + "allOf": [ + { + "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", + "example": "usps_first_class_mail", + "pattern": "^[a-z0-9]+(_[a-z0-9-]+)* ?$", + "title": "service_code", + "type": "string" + } + ], + "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" + }, + "ship_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "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" + }, + "ship_from": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address", + "type": "object" + } + ], + "title": "shipping_address", + "type": "object" + } + ], + "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" + }, + "ship_to": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + }, + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "geolocation": { + "items": { + "properties": { + "type": { + "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", + "enum": [ + "what3words" + ], + "example": "what3words", + "type": "string" + }, + "value": { + "description": "value of the geolocation item", + "example": "cats.with.thumbs", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "instructions": { + "description": "Additional text about how to handle the shipment at this address.\n", + "minLength": 1, + "nullable": true, + "type": "string" + } + }, + "title": "partial_shipping_address_to", + "type": "object" + } + ], + "title": "shipping_address_to", + "type": "object" + } + ], + "description": "The recipient's mailing address" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "shipment_number": { + "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", + "maxLength": 50, + "nullable": true, + "type": "string" + }, + "shipment_status": { + "allOf": [ + { + "description": "The possible shipment status values", + "enum": [ + "pending", + "processing", + "label_purchased", + "cancelled" + ], + "title": "shipment_status", + "type": "string" + } + ], + "default": "pending", + "description": "The current status of the shipment", + "readOnly": true + }, + "shipping_rule_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment\n" + }, + "tags": { + "default": [], + "description": "Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "tax_identifiers": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A tax identifier object", + "properties": { + "identifier_type": { + "allOf": [ + { + "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", + "enum": [ + "vat", + "eori", + "ssn", + "ein", + "tin", + "ioss", + "pan", + "voec", + "pccc", + "oss", + "passport", + "abn", + "ukims" + ], + "title": "identifier_type", + "type": "string" + } + ] + }, + "issuing_authority": { + "description": "The authority that issued this tax. This must be a valid 2 character ISO 3166 Alpha 2 country code.", + "type": "string" + }, + "taxable_entity_type": { + "allOf": [ + { + "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", + "enum": [ + "shipper", + "recipient", + "ior" + ], + "title": "taxable_entity_type", + "type": "string" + } + ] + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "required": [ + "taxable_entity_type", + "identifier_type", + "issuing_authority", + "value" + ], + "title": "tax_identifier", + "type": "object" + } + ] + }, + "nullable": true, + "type": "array" + }, + "total_weight": { + "allOf": [ + { + "additionalProperties": false, + "description": "The weight of a package", + "properties": { + "unit": { + "allOf": [ + { + "description": "The possible weight unit values", + "enum": [ + "pound", + "ounce", + "gram", + "kilogram" + ], + "title": "weight_unit", + "type": "string" + } + ] + }, + "value": { + "description": "The weight, in the specified unit", + "exclusiveMinimum": true, + "minimum": 0, + "type": "number" + } + }, + "required": [ + "value", + "unit" + ], + "title": "weight", + "type": "object" + } + ], + "description": "The combined weight of all packages in the shipment", + "readOnly": true + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "default": null, + "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", + "nullable": true + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "title": "partial_shipment", + "type": "object" + }, + { + "properties": { + "address_validation": { + "allOf": [ + { + "additionalProperties": false, + "description": "An address validation result", + "properties": { + "matched_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The matched address found by the Shipengine API", + "nullable": true, + "readOnly": true + }, + "messages": { + "default": [], + "description": "The list of messages that were generated during the address validation request.", + "items": { + "additionalProperties": false, + "description": "A response message that displays when additional info is needed for an address validation request.", + "properties": { + "code": { + "allOf": [ + { + "description": "The error codes that can be returned by the address validation API", + "enum": [ + "a1000", + "a1001", + "a1002", + "a1003", + "a1004", + "a1005", + "a1006", + "a1007", + "a1008", + "r1000", + "r1001", + "r1002", + "r1003" + ], + "title": "address_validation_code", + "type": "string" + } + ], + "readOnly": true + }, + "detail_code": { + "allOf": [ + { + "description": "The detailed error codes that can be returned by the address validation API", + "enum": [ + "unsupported_country", + "non_supported_country", + "minimum_postal_code_verification_failed", + "street_does_not_match_unique_street_name", + "multiple_directionals", + "multiple_matches", + "suite_not_valid", + "suite_missing", + "incompatible_paired_labels", + "invalid_house_number", + "missing_house_number", + "invalid_box_number", + "invalid_charge_event", + "missing_box_number", + "missing_cmra_or_private_mail_box_number", + "suite_has_no_secondaries", + "postal_code_changed_or_added", + "state_province_changed_or_added", + "city_locality_changed_or_added", + "urbanization_changed", + "street_name_spelling_changed_or_added", + "street_name_type_changed_or_added", + "street_direction_changed_or_added", + "suite_type_changed_or_added", + "suite_unit_number_changed_or_added", + "double_dependent_locality_changed_or_added", + "subadministrative_area_changed_or_added", + "subnational_area_changed_or_added", + "po_box_changed_or_added", + "premise_type_changed_or_added", + "house_number_changed", + "organization_changed_or_added", + "partially_verified_to_state_level", + "partially_verified_to_city_level", + "partially_verified_to_street_level", + "partially_verified_to_premise_level", + "verified_to_state_level", + "verified_to_city_level", + "verified_to_street_level", + "verified_to_premise_level", + "verified_to_suite_level", + "coded_to_street_lavel", + "coded_to_neighborhood_level", + "coded_to_community_level", + "coded_to_state_level", + "coded_to_rooftop_level", + "coded_to_rooftop_interpolation_level", + "name_max_length_exceeded", + "phone_max_length_exceeded", + "company_name_max_length_exceeded", + "line1_min_max_length", + "line2_max_length_exceeded", + "line3_max_length_exceeded", + "city_locality_max_length_exceeded", + "state_province_max_length_exceeded", + "invalid_postal_code", + "country_invalid_length", + "address_not_found" + ], + "title": "address_validation_detail_code", + "type": "string" + } + ], + "nullable": true + }, + "message": { + "description": "Message explaining the address validation error", + "example": "Invalid Postal Code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "type": { + "allOf": [ + { + "description": "The different types of messages that can be returned by the address validation API", + "enum": [ + "error", + "warning", + "info" + ], + "title": "address_validation_message_type", + "type": "string" + } + ], + "readOnly": true + } + }, + "required": [ + "code", + "message", + "type", + "detail_code" + ], + "title": "response_message", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "original_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The original address that was sent for validation" + }, + "status": { + "allOf": [ + { + "description": "The possible address validation status values", + "enum": [ + "unverified", + "verified", + "warning", + "error" + ], + "title": "address_validation_status", + "type": "string" + } + ] + } + }, + "required": [ + "status", + "original_address", + "matched_address", + "messages" + ], + "title": "address_validation_result", + "type": "object" + } + ], + "description": "The address validation" + }, + "errors": { + "deprecated": true, + "description": "An array of errors that occurred while creating shipment.", + "items": { + "description": "An error that occurred while creating a shipment.", + "example": "Parameter value '100000000.00' is out of range.", + "minLength": 1, + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "title": "create_shipment_response_body_fields", + "type": "object" + } + ], + "description": "A create and validate shipment resource", + "title": "create_and_validate_shipment", + "type": "object" + } + ], + "description": "An update shipment response body", + "required": [ + "errors", + "has_errors", + "address_validation", + "shipment_id", + "carrier_id", + "service_code", + "ship_date", + "created_at", + "shipment_status", + "ship_to", + "ship_from", + "return_to", + "confirmation", + "customs", + "advanced_options", + "insurance_provider", + "tags", + "packages", + "total_weight" + ], + "title": "update_shipment_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Shipment By ID", + "tags": [ + "shipments" + ] + }, + "summary": "Get and Update Shipment" + }, + "/v1/shipments/{shipment_id}/cancel": { + "description": "Cancel a Shipment", + "parameters": [ + { + "description": "Shipment ID", + "in": "path", + "name": "shipment_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "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", + "operationId": "cancel_shipments", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Cancel a Shipment", + "tags": [ + "shipments" + ] + }, + "summary": "Cancel Shipment" + }, + "/v1/shipments/{shipment_id}/rates": { + "description": "Once a shipment is complete with the desired shipping information, you can then search for rates available\nbased on the carriers associated with your account\n", + "get": { + "description": "Get Rates for the shipment information associated with the shipment ID", + "operationId": "list_shipment_rates", + "parameters": [ + { + "description": "Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)", + "example": "2019-03-12T19:24:13.657Z", + "in": "query", + "name": "created_at_start", + "required": false, + "schema": { + "format": "date-time", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A rates information resource", + "properties": { + "created_at": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "When the rate was created", + "format": "date-time", + "type": "string" + }, + "errors": { + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "type": "array" + }, + "invalid_rates": { + "default": [], + "description": "An array of invalid shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + } + ], + "description": "Invalid Shipment Rate", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "rate_request_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate request", + "readOnly": true + }, + "rates": { + "description": "An array of shipment rates", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A rate", + "properties": { + "carrier_code": { + "description": "carrier code", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_delivery_days": { + "description": "The carrier delivery days", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_friendly_name": { + "description": "carrier friendly name", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier", + "readOnly": true + }, + "carrier_nickname": { + "description": "carrier nickname", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "confirmation_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The confirmation amount. Should be added with shipping_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "delivery_days": { + "description": "The number of days estimated for delivery, this will show the _actual_ delivery\ntime if for example, the package gets shipped on a Friday\n", + "example": 5, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + }, + "error_messages": { + "description": "The error messages", + "items": { + "description": "error message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "estimated_delivery_date": { + "allOf": [ + { + "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", + "example": "2018-09-23T00:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2}))?$", + "title": "date", + "type": "string" + } + ], + "nullable": true, + "readOnly": true + }, + "guaranteed_service": { + "description": "Indicates if the rate is guaranteed.", + "readOnly": true, + "type": "boolean" + }, + "insurance_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The insurance amount. Should be added with shipping_amount, confirmation_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "negotiated_rate": { + "description": "Indicates if the rates been negotiated", + "readOnly": true, + "type": "boolean" + }, + "other_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Any other charges associated with this rate. Should be added with shipping_amount, insurance_amount and confirmation_amount to calculate the total purchase price.", + "readOnly": true + }, + "package_type": { + "description": "package type that this rate was estimated for", + "example": "package", + "minLength": 1, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "rate_details": { + "description": "A list of rate details that are associated with this rate. This is useful for\ndisplaying a breakdown of the rate to the user.\n", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a shipping cost\n", + "properties": { + "amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ] + }, + "billing_source": { + "description": "The source of the billing information. This is typically the carrier, but could be a third party, e.g insurance", + "type": "string" + }, + "carrier_billing_code": { + "description": "A rate detail code defined by a carrier", + "type": "string" + }, + "carrier_description": { + "description": "A rate detail description defined by a carrier", + "type": "string" + }, + "carrier_memo": { + "description": "Contains any additional information", + "type": "string" + }, + "rate_detail_attributes": { + "allOf": [ + { + "additionalProperties": false, + "description": "Represents detailed information about a tax (e.g. VAT) contained in a shipping cost.\n", + "properties": { + "tax_percentage": { + "description": "Tax percentage, e.g. 20 for 20%, added to the shipping cost", + "type": "number" + }, + "tax_type": { + "allOf": [ + { + "description": "Type of a tax added to shipping cost", + "enum": [ + "vat" + ], + "title": "tax_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail_attributes", + "type": "object" + } + ], + "description": "If applicable, contains additional data about a rate detail of a specific type, e.g. VAT" + }, + "rate_detail_type": { + "allOf": [ + { + "description": "The possible rate detail type values", + "enum": [ + "uncategorized", + "shipping", + "insurance", + "confirmation", + "discount", + "fuel_charge", + "additional_fees", + "tariff", + "tax", + "delivery", + "handling", + "special_goods", + "pickup", + "location_fee", + "oversize", + "returns", + "notifications", + "tip", + "duties_and_taxes", + "brokerage_fee", + "admin_fee", + "adjustment" + ], + "title": "rate_detail_type", + "type": "string" + } + ] + } + }, + "title": "rate_detail", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "rate_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the rate", + "readOnly": true + }, + "rate_type": { + "allOf": [ + { + "description": "The possible rate type values", + "enum": [ + "check", + "shipment" + ], + "title": "rate_type", + "type": "string" + } + ], + "readOnly": true + }, + "requested_comparison_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The total shipping cost for the specified comparison_rate_type.", + "readOnly": true + }, + "service_code": { + "description": "service code for the rate", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "service_type": { + "description": "service type", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "description": "ship date", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "shipping_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "The shipping amount. Should be added with confirmation_amount, insurance_amount and other_amount to calculate the total purchase price.", + "readOnly": true + }, + "tax_amount": { + "allOf": [ + { + "additionalProperties": false, + "description": "A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.\n", + "properties": { + "amount": { + "description": "The monetary amount, in the specified currency.", + "minimum": 0, + "type": "number" + }, + "currency": { + "allOf": [ + { + "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", + "title": "currency", + "type": "string" + } + ] + } + }, + "required": [ + "currency", + "amount" + ], + "title": "monetary_value", + "type": "object" + } + ], + "description": "Tariff and additional taxes associated with an international shipment.", + "readOnly": true + }, + "trackable": { + "description": "Indicates if rate is trackable", + "readOnly": true, + "type": "boolean" + }, + "validation_status": { + "allOf": [ + { + "description": "The possible validation status values", + "enum": [ + "valid", + "invalid", + "has_warnings", + "unknown" + ], + "title": "validation_status", + "type": "string" + } + ], + "readOnly": true + }, + "warning_messages": { + "description": "The warning messages", + "items": { + "description": "warning message", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "minItems": 0, + "readOnly": true, + "type": "array" + }, + "zone": { + "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", + "example": 6, + "format": "int32", + "minimum": 0, + "nullable": true, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "rate_id", + "rate_type", + "carrier_id", + "shipping_amount", + "insurance_amount", + "confirmation_amount", + "other_amount", + "zone", + "package_type", + "guaranteed_service", + "negotiated_rate", + "service_type", + "service_code", + "trackable", + "carrier_code", + "carrier_nickname", + "carrier_friendly_name", + "validation_status", + "warning_messages", + "error_messages" + ], + "title": "rate", + "type": "object" + }, + { + "properties": { + "rate_attributes": { + "description": "Optional attributes that indicate the most profitable rates", + "items": { + "allOf": [ + { + "description": "Optional attributes that indicate the most profitable rates", + "enum": [ + "best_value", + "cheapest", + "fastest" + ], + "title": "rate_attributes", + "type": "string" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "description": "Shipment Rates", + "readOnly": true + }, + "readOnly": true, + "type": "array" + }, + "shipment_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the shipment", + "readOnly": true + }, + "status": { + "allOf": [ + { + "description": "The possible rate response status values", + "enum": [ + "working", + "completed", + "partial", + "error" + ], + "title": "rate_response_status", + "type": "string" + } + ], + "readOnly": true + } + }, + "title": "rates_information", + "type": "object" + } + ], + "description": "A list shipment rates response body", + "required": [ + "rates", + "invalid_rates", + "rate_request_id", + "shipment_id", + "created_at", + "status", + "errors" + ], + "title": "list_shipment_rates_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Shipment Rates", + "tags": [ + "shipments" + ] + }, + "parameters": [ + { + "description": "Shipment ID", + "in": "path", + "name": "shipment_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Shipment Rates" + }, + "/v1/shipments/{shipment_id}/tags": { + "description": "Tags associated with the shipment object to be used to organize and query shipment items.\n", + "get": { + "description": "Get Shipment tags based on its ID", + "operationId": "shipments_list_tags", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "Get shipment tags response body", + "properties": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tags" + ], + "title": "tag_shipment_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Shipment Tags", + "tags": [ + "shipments" + ] + }, + "parameters": [ + { + "description": "Shipment ID", + "in": "path", + "name": "shipment_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "summary": "Shipment Tags" + }, + "/v1/shipments/{shipment_id}/tags/{tag_name}": { + "delete": { + "description": "Remove an existing tag from the Shipment object", + "operationId": "untag_shipment", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Remove Tag from Shipment", + "tags": [ + "shipments" + ] + }, + "description": "Tags associated with the shipment object to be used to organize and query shipment items.\n", + "parameters": [ + { + "description": "Shipment ID", + "in": "path", + "name": "shipment_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + }, + { + "in": "path", + "name": "tag_name", + "required": true, + "schema": { + "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", + "example": "Fragile", + "minLength": 1, + "title": "tag_name", + "type": "string" + } + } + ], + "post": { + "description": "Add a tag to the shipment object", + "operationId": "tag_shipment", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "Get shipment tags response body", + "properties": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "tags" + ], + "title": "tag_shipment_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Add Tag to Shipment", + "tags": [ + "shipments" + ] + }, + "summary": "Shipment Tags" + }, + "/v1/tags": { + "description": "Tags are simple text-based flags or identifiers. Tags can be used as a simple label,\nsuch as Guaranteed_Overnight or Fragile so shipments can be easily [queried later](https://www.shipengine.com/docs/reference/list-shipments/).\n", + "get": { + "description": "Get a list of all tags associated with an account.", + "operationId": "list_tags", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "Response body from a successful GET /tags API call", + "properties": { + "tags": { + "description": "The array of tags returned by the API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ] + }, + "type": "array" + } + }, + "title": "list_tags_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Tags", + "tags": [ + "tags" + ] + }, + "post": { + "description": "Create a new tag for customizing how you track your shipments.", + "operationId": "create_tag", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A create tag request body", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "create_tag_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ], + "description": "Response body for creating tags", + "title": "create_tag_response_body", + "type": "object" + } + } + }, + "description": "The requested object creation was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create a New Tag", + "tags": [ + "tags" + ] + }, + "summary": "Tags" + }, + "/v1/tags/{tag_name}": { + "delete": { + "description": "Delete a tag that is no longer needed", + "operationId": "delete_tag", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Delete Tag", + "tags": [ + "tags" + ] + }, + "description": "Create and delete tags", + "parameters": [ + { + "in": "path", + "name": "tag_name", + "required": true, + "schema": { + "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", + "example": "Fragile", + "minLength": 1, + "title": "tag_name", + "type": "string" + } + } + ], + "post": { + "description": "Create a new tag for customizing how you track your shipments (deprecated - use POST /v1/tags instead)", + "operationId": "create_tag", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "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", + "properties": { + "color": { + "description": "A hex-coded string identifying the color of the tag.", + "example": "#FF0000", + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The tag name.", + "example": "Fragile", + "minLength": 1, + "type": "string" + }, + "tag_id": { + "description": "An integer uniquely identifying a tag.", + "example": 8712, + "format": "int32", + "minimum": 1, + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "name" + ], + "title": "tag", + "type": "object" + } + ], + "description": "Response body for creating tags", + "title": "create_tag_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create a New Tag", + "tags": [ + "tags" + ] + }, + "summary": "Tag" + }, + "/v1/tags/{tag_name}/{new_tag_name}": { + "description": "Update tag name", + "parameters": [ + { + "in": "path", + "name": "tag_name", + "required": true, + "schema": { + "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", + "example": "Fragile", + "minLength": 1, + "title": "tag_name", + "type": "string" + } + }, + { + "in": "path", + "name": "new_tag_name", + "required": true, + "schema": { + "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", + "example": "Fragile", + "minLength": 1, + "title": "tag_name", + "type": "string" + } + } + ], + "put": { + "description": "Change a tag name while still keeping the relevant shipments attached to it", + "operationId": "rename_tag", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Tag Name", + "tags": [ + "tags" + ] + }, + "summary": "Tag" + }, + "/v1/tokens/ephemeral": { + "post": { + "description": "This endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds.", + "operationId": "tokens_get_ephemeral_token", + "parameters": [ + { + "description": "Include a redirect url to the application formatted with the ephemeral token.", + "in": "query", + "name": "redirect", + "required": false, + "schema": { + "description": "The resource to return a redirect URL to.", + "enum": [ + "shipengine-dashboard" + ], + "title": "redirect", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "redirect_url": { + "description": "The redirect url formatted with the requested token.", + "type": "string" + }, + "token": { + "description": "The requested token that expires in 10 seconds.", + "type": "string" + } + }, + "title": "tokens_get_ephemeral_token_response_body.yaml", + "type": "object" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Ephemeral Token", + "tags": [ + "tokens" + ] + } + }, + "/v1/tracking": { + "description": "If you generate your labels through ShipEngine, then you can subscribe to real-time tracking events for free!", + "get": { + "description": "Retrieve package tracking information", + "operationId": "get_tracking_log", + "parameters": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "stamps_com", + "in": "query", + "name": "carrier_code", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "The tracking number associated with a shipment", + "example": "9405511899223197428490", + "in": "query", + "name": "tracking_number", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "Carrier ID", + "in": "query", + "name": "carrier_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A tracking information resource", + "properties": { + "actual_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ] + }, + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_id": { + "description": "The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label\n", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "estimated_delivery_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "events": { + "description": "The events that have occured during the lifetime of this tracking number.", + "items": { + "additionalProperties": false, + "description": "A track event", + "properties": { + "carrier_detail_code": { + "description": "Carrier detail code", + "example": "OT", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Carrier timestamp for the event, it is assumed to be the local time of where the event occurred." + }, + "carrier_status_code": { + "description": "Carrier status code", + "example": 1, + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "carrier_status_description": { + "description": "carrier status description", + "example": "Your item was delivered in or at the mailbox at 9:10 am on March", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "city_locality": { + "description": "City locality", + "example": "AUSTIN", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "company_name": { + "description": "Company Name", + "example": "Stamps.com", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ] + }, + "description": { + "description": "Event description", + "example": "Delivered, In/At Mailbox", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "event_code": { + "description": "Event Code", + "minLength": 0, + "type": "string" + }, + "latitude": { + "description": "Latitude coordinate of tracking event.", + "format": "double", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "description": "Longitude coordinate of tracking event.", + "format": "double", + "maximum": 180, + "minimum": -180, + "type": "number" + }, + "occurred_at": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ], + "description": "Timestamp for carrier event" + }, + "postal_code": { + "description": "Postal code", + "example": 78756, + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "proof_of_delivery_url": { + "description": "A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.", + "example": "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png", + "readOnly": true, + "type": "string" + }, + "signer": { + "description": "Signer information", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "state_province": { + "description": "State province", + "example": "TX", + "minLength": 2, + "readOnly": true, + "type": "string" + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "IT" + }, + "status_description": { + "description": "Event Status Description", + "example": "In Transit", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "IN_TRANSIT" + }, + "status_detail_description": { + "description": "Event Status Detail Description", + "example": "Your shipment is on its way between the carrier hubs.", + "minLength": 0, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "occurred_at", + "city_locality", + "state_province", + "postal_code", + "carrier_detail_code", + "status_code", + "status_description", + "carrier_status_code", + "carrier_status_description" + ], + "title": "track_event", + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "exception_description": { + "description": "Exception description", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "ship_date": { + "allOf": [ + { + "description": "An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.\n", + "example": "2018-09-23T15:00:00.000Z", + "format": "date-time", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[-+]\\d{2}:\\d{2})$", + "title": "date_time", + "type": "string" + } + ] + }, + "status_code": { + "allOf": [ + { + "description": "The tracking status codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n|`UN` | Unknown\n|`AC` | Accepted\n|`IT` | In Transit\n|`DE` | Delivered\n|`EX` | Exception\n|`AT` | Delivery Attempt\n|`NY` | Not Yet In System\n|`SP` | Delivered To Collection Location\n", + "enum": [ + "UN", + "AC", + "IT", + "DE", + "EX", + "AT", + "NY", + "SP" + ], + "readOnly": true, + "title": "status_code", + "type": "string" + } + ], + "example": "DE" + }, + "status_description": { + "description": "Status description", + "example": "Delivered", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "status_detail_code": { + "allOf": [ + { + "description": "The tracking status detail codes\n\n|Value |Description\n|:--------- |:-----------------------------------------------------\n| `CARRIER_STATUS_NOT_MAPPED` | Status not mapped. Please check the carrier's website for updates.\n| `SHIPMENT_CREATED` | Your tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.\n| `AWAITING_PICKUP_DROP_OFF` | Your parcel is waiting to be handed over to the carrier.\n| `DROPPED_OFF` | Your parcel has been dropped off and is ready for carrier processing.\n| `ELEC_ADVICE_RECD_BY_CARRIER` | Your shipment is now in the carrier's system.\n| `PICKED_UP` | Your parcel has been picked up by the carrier.\n| `CUSTOMS_CLEARED` | Your parcel has cleared customs and is continuing its journey.\n| `CUSTOMS_PROCESSING` | Your parcel is currently being processed by customs.\n| `DELIVERY_ARRANGED_WITH_RECIPIENT` | Your parcel's delivery has been arranged with the carrier.\n| `HUB_SCAN_OUT` | Your parcel has left the carrier's hub.\n| `HUB_SCAN_IN` | Your parcel has arrived at the carrier's hub for processing.\n| `IN_TRANSIT` | Your shipment is on its way between the carrier hubs.\n| `INFORMATION` | The carrier has shared additional information about your parcel.\n| `PARCEL_OVER_LABELLED` | Your parcel's label has been updated by the carrier, which may affect tracking visibility.\n| `PARCEL_UPDATE_NOTIFICATION` | The carrier has sent you an update on your parcel status via SMS or email.\n| `RECEIVED_BY_CARRIER` | Your parcel has been received by the carrier and is beginning its journey.\n| `RECEIVED_LOCAL_DELIVERY_DEPOT` | Your parcel has arrived at the local delivery depot and is almost ready for delivery.\n| `SUB_CONTRACTOR_EVENT` | The carrier has shared additional information about your parcel's handling by a delivery partner.\n| `SUB_CONTRACTOR_RECEIVED` | Your parcel has been received by the carrier's local delivery partner.\n| `PARCEL_REDIRECTED` | Your parcel has been redirected to a new delivery address per your request.\n| `DELIVERY_SCHEDULED` | Your parcel's delivery has been scheduled and will soon be out for delivery.\n| `HUB_PROCESSING` | Your parcel is being processed at a carrier hub.\n| `DELIVERY_RESCHEDULED` | Your parcel's delivery has been rescheduled due to operational issues.\n| `ATTEMPTED_DELIVERY` | The carrier attempted to deliver your parcel but was unable to complete delivery.\n| `ATTEMPTED_DELIVERY_FINAL` | The carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.\n| `COD_AMOUNT_PAID` | Cash on delivery payment received.\n| `CUSTOMER_CARDED` | Delivery attempt failed. Please follow delivery instructions left by the carrier.\n| `OUT_FOR_DELIVERY` | Your parcel is on its way and will be delivered today.\n| `AWAITING_COLLECTION_FROM_PICKUP_POINT` | Your parcel is ready for collection at the selected pickup point.\n| `COLLECT_AT_LOCAL_PO` | Your parcel is ready for collection at your local post office.\n| `CUSTOMER_TO_COLLECT_FROM_CARRIER` | Your parcel is available for collection from the carrier's local delivery unit.\n| `DELIVERED_TO_RECEPTION` | Your parcel has been delivered to your building's reception or designated mail area.\n| `DELIVERED` | Your parcel has been successfully delivered.\n| `DELIVERED_DAMAGED` | Your parcel was delivered but arrived with visible damage.\n| `DELIVERED_IN_PART` | Part of your shipment has been delivered. Check for updates on the rest.\n| `DELIVERED_SPECIFIED_SAFE_PLACE` | Your parcel has been delivered to your specified safe place.\n| `DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION` | Your parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.\n| `DELIVERED_TO_NEIGHBOUR` | Your parcel was delivered to your neighbor.\n| `DELIVERED_TO_PO_BOX` | Your parcel has been delivered to your specified PO Box.\n| `PARCEL_COLLECTED_FROM_PICKUP_POINT` | Your package has been picked up from the pick up point.\n| `POST_TRANSIT_STATUS` | The carrier has added more information about your delivery.\n| `PROOF_OF_DELIVERY` | The carrier has confirmed delivery with proof, such as a signature or photo.\n| `PICKUP_FAILED` | Parcel pickup failed. The delivery company will try again soon.\n| `NOT_YET_RECEIVED_BY_CARRIER` | The carrier has not yet received your parcel, which may cause a delay.\n| `PARCEL_DAMAGED` | Your parcel was damaged in transit but will still be delivered.\n| `ADDRESS_QUERY` | There is an issue with the delivery address, which may delay your parcel.\n| `CARRIER_DELAYS` | Your parcel is delayed due to issues within the carrier network.\n| `DELAYED_NOT_CARRIER` | Your parcel is delayed due to circumstances beyond the carrier's control.\n| `HELD_BY_CARRIER` | Your parcel is being held due to an operational issue. Contact with the carrier for more information.\n| `HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING` | Your parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.\n| `HELD_BY_CUSTOMS` | Your parcel is being held at customs, which may delay delivery.\n| `INCORRECT_DECLARATION` | Your parcel has been incorrectly declared but is still moving forward for delivery.\n| `MISROUTED` | Your parcel was sent to the wrong place due to a routing error but is being redirected.\n| `PARCEL_REPACKED` | Your parcel was repackaged by the carrier due to damage and will still be delivered.\n| `RECD_BY_CARRIER_NO_ELEC_ADVICE` | Your parcel has been received by the carrier but may experience delays due to missing pre-advice.\n| `COD_AMOUNT_NOT_PAID` | Delivery failed due to unpaid cash on delivery. Please follow carrier instructions.\n| `CUSTOMER_IDENTIFICATION_FAILED` | Delivery couldn't be completed as identification requirements were not met.\n| `NO_ACCESS_TO_RECIPIENTS_ADDRESS` | The carrier couldn't access the delivery location due to restricted entry.\n| `CANCELLED` | Your parcel has been cancelled.\n| `CUSTOMER_MOVED` | Delivery failed as the recipient is no longer at the specified address. Your parcel is being returned.\n| `HAZARDOUS_PROHIBITED` | Your parcel contains restricted items and will not be delivered.\n| `NOT_COLLECTED_FROM_PICKUP_POINT` | Your parcel was not collected from the pickup point within the designated time and will be returned.\n| `NOT_DELIVERED` | All delivery attempts failed. Your parcel is being returned to the sender.\n| `NOT_DELIVERED_ADDRESSEE_DECEASED` | The parcel could not be delivered as the addressee is reported deceased.\n| `PARCEL_DISPOSED` | Your parcel has been disposed of due to its contents or condition and will not be delivered.\n| `PARCEL_LOST` | The carrier has reported that your parcel is lost and will not be delivered.\n| `PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY` | The parcel cannot be delivered as it exceeds the carrier's service limits.\n| `REFUSED_BY_CUSTOMER` | You have refused the parcel, and it will be returned to the sender.\n| `RETURN_TO_SENDER` | Your parcel is being returned to the sender due to delivery issues.\n| `UNSPECIFIED_EXCEPTION` | The carrier has reported an issue with your parcel, but details are unavailable.\n| `TRACKING_EXPIRED` | Tracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.\n| `DUTY_NOT_PAID` | The import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.\n| `PARCEL_REDIRECTED_BY_CARRIER` | The carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.\n| `DELIVERED_TO_PICKUP_POINT` | Your package has been delivered to the pickup point. You will be notified when its ready for collection.\n| `UNDELIVERABLE_RETURNED_TO_SENDER` | The shipment has been returned to the sender. Please contact the sender for further information.\n", + "enum": [ + "CARRIER_STATUS_NOT_MAPPED", + "SHIPMENT_CREATED", + "AWAITING_PICKUP_DROP_OFF", + "DROPPED_OFF", + "ELEC_ADVICE_RECD_BY_CARRIER", + "PICKED_UP", + "CUSTOMS_CLEARED", + "CUSTOMS_PROCESSING", + "DELIVERY_ARRANGED_WITH_RECIPIENT", + "HUB_SCAN_OUT", + "HUB_SCAN_IN", + "IN_TRANSIT", + "INFORMATION", + "PARCEL_OVER_LABELLED", + "PARCEL_UPDATE_NOTIFICATION", + "RECEIVED_BY_CARRIER", + "RECEIVED_LOCAL_DELIVERY_DEPOT", + "SUB_CONTRACTOR_EVENT", + "SUB_CONTRACTOR_RECEIVED", + "PARCEL_REDIRECTED", + "DELIVERY_SCHEDULED", + "HUB_PROCESSING", + "DELIVERY_RESCHEDULED", + "ATTEMPTED_DELIVERY", + "ATTEMPTED_DELIVERY_FINAL", + "COD_AMOUNT_PAID", + "CUSTOMER_CARDED", + "OUT_FOR_DELIVERY", + "AWAITING_COLLECTION_FROM_PICKUP_POINT", + "COLLECT_AT_LOCAL_PO", + "CUSTOMER_TO_COLLECT_FROM_CARRIER", + "DELIVERED_TO_RECEPTION", + "DELIVERED", + "DELIVERED_DAMAGED", + "DELIVERED_IN_PART", + "DELIVERED_SPECIFIED_SAFE_PLACE", + "DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION", + "DELIVERED_TO_NEIGHBOUR", + "DELIVERED_TO_PO_BOX", + "PARCEL_COLLECTED_FROM_PICKUP_POINT", + "POST_TRANSIT_STATUS", + "PROOF_OF_DELIVERY", + "PICKUP_FAILED", + "NOT_YET_RECEIVED_BY_CARRIER", + "PARCEL_DAMAGED", + "ADDRESS_QUERY", + "CARRIER_DELAYS", + "DELAYED_NOT_CARRIER", + "HELD_BY_CARRIER", + "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING", + "HELD_BY_CUSTOMS", + "INCORRECT_DECLARATION", + "MISROUTED", + "PARCEL_REPACKED", + "RECD_BY_CARRIER_NO_ELEC_ADVICE", + "COD_AMOUNT_NOT_PAID", + "CUSTOMER_IDENTIFICATION_FAILED", + "NO_ACCESS_TO_RECIPIENTS_ADDRESS", + "CANCELLED", + "CUSTOMER_MOVED", + "HAZARDOUS_PROHIBITED", + "NOT_COLLECTED_FROM_PICKUP_POINT", + "NOT_DELIVERED", + "NOT_DELIVERED_ADDRESSEE_DECEASED", + "PARCEL_DISPOSED", + "PARCEL_LOST", + "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY", + "REFUSED_BY_CUSTOMER", + "RETURN_TO_SENDER", + "UNSPECIFIED_EXCEPTION", + "TRACKING_EXPIRED", + "DUTY_NOT_PAID", + "PARCEL_REDIRECTED_BY_CARRIER", + "DELIVERED_TO_PICKUP_POINT", + "UNDELIVERABLE_RETURNED_TO_SENDER" + ], + "readOnly": true, + "title": "status_detail_code", + "type": "string" + } + ], + "example": "DELIVERED" + }, + "status_detail_description": { + "description": "Status detail description", + "example": "Your parcel has been successfully delivered.", + "minLength": 0, + "readOnly": true, + "type": "string" + }, + "tracking_number": { + "allOf": [ + { + "description": "A tracking number for a package. The format depends on the carrier.", + "example": "1Z932R800392060079", + "minLength": 1, + "title": "tracking_number", + "type": "string" + } + ] + }, + "tracking_url": { + "description": "Carrier Tracking Url, if available", + "example": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", + "readOnly": true, + "type": "string" + } + }, + "title": "tracking_information", + "type": "object" + } + ], + "description": "A get tracking log response body", + "required": [ + "tracking_number", + "tracking_url", + "status_code", + "carrier_code", + "carrier_id", + "carrier_detail_code", + "carrier_status_code", + "events" + ], + "title": "get_tracking_log_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Tracking Information", + "tags": [ + "tracking" + ] + }, + "summary": "Tracking a Package" + }, + "/v1/tracking/start": { + "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", + "post": { + "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", + "operationId": "start_tracking", + "parameters": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "stamps_com", + "in": "query", + "name": "carrier_code", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "The tracking number associated with a shipment", + "example": "9405511899223197428490", + "in": "query", + "name": "tracking_number", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "Carrier ID", + "in": "query", + "name": "carrier_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Start Tracking a Package", + "tags": [ + "tracking" + ] + }, + "summary": "Start Tracking a Package" + }, + "/v1/tracking/stop": { + "description": "Unsubscribe from tracking updates for a package.", + "post": { + "description": "Unsubscribe from tracking updates for a package.", + "operationId": "stop_tracking", + "parameters": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "stamps_com", + "in": "query", + "name": "carrier_code", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "The tracking number associated with a shipment", + "example": "9405511899223197428490", + "in": "query", + "name": "tracking_number", + "required": false, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "description": "Carrier ID", + "in": "query", + "name": "carrier_id", + "required": false, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Stop Tracking a Package", + "tags": [ + "tracking" + ] + }, + "summary": "Stop Tracking a Package" + }, + "/v1/warehouses": { + "description": "You likely have one or more warehouse locations that you frequently ship from, in which case it would be annoying to have to specify the\nship_from and return_to addresses on every shipment. The solution is to [Create a Warehouse](https://www.shipengine.com/docs/reference/create-warehouse/), then you can simply pass the warehouse_id instead.\n", + "get": { + "description": "Retrieve a list of warehouses associated with this account.", + "operationId": "list_warehouses", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "A warehouse list response body", + "properties": { + "warehouses": { + "description": "The array of warehouses returned by the API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "readOnly": true + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "warehouses" + ], + "title": "list_warehouses_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "List Warehouses", + "tags": [ + "warehouses" + ] + }, + "post": { + "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", + "operationId": "create_warehouse", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "A create warehouse request body", + "required": [ + "name", + "origin_address" + ], + "title": "create_warehouse_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "A create warehouse response body", + "required": [ + "warehouse_id", + "name", + "created_at", + "origin_address", + "return_address" + ], + "title": "create_warehouse_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Create Warehouse", + "tags": [ + "warehouses" + ] + }, + "summary": "Warehouses" + }, + "/v1/warehouses/{warehouse_id}": { + "delete": { + "description": "Delete a warehouse by ID", + "operationId": "delete_warehouse", + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Delete Warehouse By ID", + "tags": [ + "warehouses" + ] + }, + "description": "You likely have one or more warehouse locations that you frequently ship from, in which case it would be annoying to have to specify the\nship_from and return_to addresses on every shipment. The solution is to [Create a Warehouse](https://www.shipengine.com/docs/reference/create-warehouse/), then you can simply pass the warehouse_id instead.\n", + "get": { + "description": "Retrieve warehouse data based on the warehouse ID", + "operationId": "get_warehouse_by_id", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "A get warehouse by id response body", + "required": [ + "warehouse_id", + "name", + "created_at", + "origin_address", + "return_address" + ], + "title": "get_warehouse_by_id_response_body", + "type": "object" + } + } + }, + "description": "The request was a success." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Get Warehouse By Id", + "tags": [ + "warehouses" + ] + }, + "parameters": [ + { + "description": "Warehouse ID", + "in": "path", + "name": "warehouse_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Update Warehouse object information", + "operationId": "update_warehouse", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A warehouse", + "properties": { + "created_at": { + "description": "Timestamp that indicates when the warehouse was created", + "example": "2019-06-25T18:12:35.583Z", + "format": "date-time", + "minLength": 1, + "readOnly": true, + "type": "string" + }, + "is_default": { + "default": false, + "description": "Designates which single warehouse is the default on the account", + "nullable": true, + "type": "boolean" + }, + "name": { + "description": "Name of the warehouse", + "example": "Zero Cool HQ", + "minLength": 1, + "type": "string" + }, + "origin_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The origin address of the warehouse" + }, + "return_address": { + "allOf": [ + { + "additionalProperties": false, + "allOf": [ + { + "additionalProperties": false, + "description": "A complete or partial mailing address.", + "properties": { + "address_line1": { + "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.", + "minLength": 1, + "type": "string" + }, + "address_line2": { + "description": "The second line of the street address. For some addresses, this line may not be needed.\n", + "example": "Unit 408", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_line3": { + "description": "The third line of the street address. For some addresses, this line may not be needed.\n", + "example": "Building #7", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "address_residential_indicator": { + "allOf": [ + { + "description": "Indicates whether an address is residential.", + "enum": [ + "unknown", + "yes", + "no" + ], + "title": "address_residential_indicator", + "type": "string" + } + ], + "default": "unknown", + "description": "Indicates whether this is a residential address.", + "example": "no" + }, + "city_locality": { + "description": "The name of the city or locality", + "example": "Winnipeg", + "minLength": 1, + "type": "string" + }, + "company_name": { + "description": "If this is a business address, then the company name should be specified here.\n", + "example": "The Home Depot", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "country_code": { + "allOf": [ + { + "description": "A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n", + "example": "CA", + "maxLength": 2, + "minLength": 2, + "title": "country_code", + "type": "string" + } + ], + "description": "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)\n" + }, + "email": { + "description": "Email for the address owner.\n", + "example": "example@example.com", + "nullable": true, + "type": "string" + }, + "name": { + "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", + "example": "John Doe", + "minLength": 1, + "type": "string" + }, + "phone": { + "description": "The phone number of a contact person at this address. The format of this phone number varies depending on the country.\n", + "example": "+1 204-253-9411 ext. 123", + "minLength": 1, + "type": "string" + }, + "postal_code": { + "allOf": [ + { + "description": "postal code", + "example": "78756-3717", + "minLength": 1, + "title": "postal_code", + "type": "string" + } + ] + }, + "state_province": { + "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", + "example": "Manitoba", + "minLength": 1, + "type": "string" + } + }, + "title": "partial_address", + "type": "object" + } + ], + "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", + "required": [ + "name", + "address_line1", + "city_locality", + "state_province", + "postal_code" + ], + "title": "address", + "type": "object" + } + ], + "description": "The return address associated with the warehouse" + }, + "warehouse_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the warehouse", + "readOnly": true + } + }, + "title": "warehouse", + "type": "object" + } + ], + "description": "An update warehouse request body", + "required": [ + "name", + "origin_address" + ], + "title": "update_warehouse_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Warehouse By Id", + "tags": [ + "warehouses" + ] + }, + "summary": "Warehouse" + }, + "/v1/warehouses/{warehouse_id}/settings": { + "description": "Warehouse settings", + "parameters": [ + { + "description": "Warehouse ID", + "in": "path", + "name": "warehouse_id", + "required": true, + "schema": { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + } + ], + "put": { + "description": "Update Warehouse settings object information", + "operationId": "update_warehouse_settings", + "requestBody": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An update warehouse settings request body", + "properties": { + "is_default": { + "description": "The default property on the warehouse.", + "example": true, + "nullable": true, + "type": "boolean" + } + }, + "title": "update_warehouse_settings_request_body", + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": { + "application/json": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + }, + "text/plain": { + "schema": { + "maxLength": 0, + "minLength": 0, + "title": "empty_response_body", + "type": "string" + } + } + }, + "description": "The request was successful." + }, + "400": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The request contained errors." + }, + "404": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "The specified resource does not exist." + }, + "500": { + "content": { + "application/json": { + "schema": { + "additionalProperties": false, + "description": "An error response body", + "properties": { + "errors": { + "description": "The errors associated with the failed API call", + "items": { + "allOf": [ + { + "additionalProperties": false, + "description": "The error structure that gets returned with almost all failed API calls\n", + "properties": { + "carrier_code": { + "allOf": [ + { + "description": "A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "example": "dhl_express", + "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$", + "title": "carrier_code", + "type": "string" + } + ], + "description": "The name of the [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.\n", + "readOnly": true + }, + "carrier_id": { + "allOf": [ + { + "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.", + "example": "se-28529731", + "maxLength": 25, + "minLength": 1, + "pattern": "^se(-[a-z0-9]+)+$", + "title": "se_id", + "type": "string" + } + ], + "description": "A string that uniquely identifies the carrier that generated the error.", + "readOnly": true + }, + "error_code": { + "allOf": [ + { + "description": "The error code specified for the failed API Call", + "enum": [ + "auto_fund_not_supported", + "batch_cannot_be_modified", + "carrier_conflict", + "carrier_disconnected", + "carrier_not_connected", + "carrier_not_supported", + "confirmation_not_supported", + "default_warehouse_cannot_be_deleted", + "field_conflict", + "field_value_required", + "forbidden", + "identifier_conflict", + "identifiers_must_match", + "insufficient_funds", + "invalid_address", + "invalid_billing_plan", + "invalid_field_value", + "invalid_identifier", + "invalid_status", + "invalid_string_length", + "label_images_not_supported", + "meter_failure", + "order_source_not_active", + "rate_limit_exceeded", + "refresh_not_supported", + "request_body_required", + "return_label_not_supported", + "settings_not_supported", + "subscription_inactive", + "terms_not_accepted", + "tracking_not_supported", + "trial_expired", + "unauthorized", + "unknown", + "unspecified", + "verification_failure", + "warehouse_conflict", + "webhook_event_type_conflict", + "customs_items_required", + "incompatible_paired_labels", + "invalid_charge_event", + "invalid_object", + "no_rates_returned", + "file_not_found", + "shipping_rule_not_found", + "service_not_determined", + "no_rates_returned", + "funding_source_registration_in_progress", + "insurance_failure", + "funding_source_missing_configuration", + "funding_source_error" + ], + "title": "error_code", + "type": "string" + } + ] + }, + "error_source": { + "allOf": [ + { + "description": "The source of the error, as indicated by the name this informs us if the API call failed because of the\ncarrier, the order source, or the ShipEngine API itself.\n", + "enum": [ + "carrier", + "order_source", + "shipengine" + ], + "title": "error_source", + "type": "string" + } + ] + }, + "error_type": { + "allOf": [ + { + "description": "The type of error\n", + "enum": [ + "account_status", + "business_rules", + "validation", + "security", + "system", + "integrations" + ], + "title": "error_type", + "type": "string" + } + ] + }, + "field_name": { + "description": "The name of the field that caused the error", + "example": "shipment.ship_to.phone_number", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "An error message associated with the failed API call", + "example": "Body of request cannot be null.", + "minLength": 1, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "error_source", + "error_type", + "error_code", + "message" + ], + "title": "error", + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + }, + "request_id": { + "allOf": [ + { + "description": "A UUID (a.k.a. GUID) that uniquely identifies a resource", + "example": "aa3d8e8e-462b-4476-9618-72db7f7b7009", + "format": "uuid", + "maxLength": 36, + "minLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "title": "uuid", + "type": "string" + } + ], + "description": "A UUID that uniquely identifies the request id.\nThis can be given to the support team to help debug non-trivial issues that may occur\n" + } + }, + "required": [ + "request_id", + "errors" + ], + "title": "error_response_body", + "type": "object" + } + } + }, + "description": "An error occurred on ShipEngine's side.\n\n> This error will automatically be reported to our engineers.\n" + } + }, + "summary": "Update Warehouse Settings", + "tags": [ + "warehouses" + ] + }, + "summary": "Warehouse settings" + } + }, + "security": [ + { + "api_key": [] + } + ], + "servers": [ + { + "url": "https://api.shipengine.com" + } + ], + "tags": [ + { + "description": "For additional information about the ShipEngine account. \n", + "name": "account", + "x-displayName": "Account" + }, + { + "description": "No matter your shipping volume, failed deliveries and address change surcharges cut into your bottom line and damage perception with customers. Our address validation services ensure your packages make it to the right place the first time. [Learn how to leverage our address validation services here.](https://www.shipengine.com/docs/addresses/validation/)\n\nShipEngine supports address validation for virtually every country on Earth, including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.\n", + "externalDocs": { + "description": "Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.\n", + "url": "https://www.shipengine.com/docs/addresses/validation/" + }, + "name": "addresses", + "x-displayName": "Addresses" + }, + { + "description": "batches\n", + "name": "batches", + "x-displayName": "Batches" + }, + { + "description": "A carrier account is a connection to a shipping carrier that allows you to create labels, track packages, and more. You can connect your own carrier accounts to ShipEngine, or use one of our built-in carrier accounts. [Learn more about carrier accounts here.](https://www.shipengine.com/docs/carriers/setup/)\n", + "name": "carrier_accounts", + "x-displayName": "Carrier Accounts" + }, + { + "description": "carriers\n", + "name": "carriers", + "x-displayName": "Carriers" + }, + { + "description": "downloads\n", + "name": "downloads", + "x-displayName": "Downloads" + }, + { + "description": "insurance\n", + "name": "insurance", + "x-displayName": "Insurance" + }, + { + "description": "Print shipping labels for any of the top global carriers in minutes\u2014instead of weeks. Simply [connect your existing carrier accounts](https://www.shipengine.com/docs/carriers/setup/) in the API dashboard, and then [begin creating labels](https://www.shipengine.com/docs/shipping/use-a-carrier-service/).\n", + "externalDocs": { + "description": "Follow this quick start guide to create your first shipping label with ShipEngine", + "url": "https://www.shipengine.com/docs/labels/create-a-label/" + }, + "name": "labels", + "x-displayName": "Labels" + }, + { + "description": "manifests\n", + "name": "manifests", + "x-displayName": "Manifests" + }, + { + "description": "Scheduled package pickups", + "name": "package_pickups", + "x-displayName": "Package Pickups" + }, + { + "description": "custom package types\n", + "name": "package_types", + "x-displayName": "Package Types" + }, + { + "description": "Make sure you ship as cost-effectively as possible by [quickly comparing rates](https://www.shipengine.com/docs/rates/) using the ShipEngine Rates API. As long as you have the carrier connected to your account, you'll be able to see and compare different rates and services.\n", + "externalDocs": { + "description": "This quick start guide shows you how to get shipping rates for multiple carriers so you can choose the fastest, cheapest, or most reliable option.\n", + "url": "https://www.shipengine.com/docs/rates/" + }, + "name": "rates", + "x-displayName": "Rates" + }, + { + "name": "service_points", + "x-displayName": "Service Points" + }, + { + "description": "Shipments are at the center of the ShipEngine API. A shipment is the first step in [creating a shipping label](https://www.shipengine.com/docs/labels/create-a-label/), or [creating a manifest](https://www.shipengine.com/docs/shipping/manifests/). It's also essential for [getting shipping rates](https://www.shipengine.com/docs/rates/).\n", + "externalDocs": { + "description": "Learn about the shipment object model concept, and how to persist and re-use shipment data inside ShipEngine.\n", + "url": "https://www.shipengine.com/docs/shipping/create-a-shipment/" + }, + "name": "shipments", + "x-displayName": "Shipments" + }, + { + "description": "tags\n", + "name": "tags", + "x-displayName": "Tags" + }, + { + "name": "tokens", + "x-displayName": "Tokens" + }, + { + "description": "[Track packages](https://www.shipengine.com/docs/tracking/) across any of our 20+ supported carrier accounts and create tracking events to keep your customers up-to-date. Easily integrate real-time tracking information for shipments into your app, email, or SMS.\n", + "externalDocs": { + "description": "Learn how to use ShipEngine to track any package with a carrier and a tracking number", + "url": "https://www.shipengine.com/docs/tracking/" + }, + "name": "tracking", + "x-displayName": "Tracking" + }, + { + "description": "warehouses\n", + "name": "warehouses", + "x-displayName": "Warehouses" + }, + { + "description": "[Webhooks](https://www.shipengine.com/docs/tracking/webhooks/) are a powerful feature of ShipEngine that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipEngine will automatically contact your servers when the stage changes. This can include [parcel tracking](https://www.shipengine.com/docs/tracking/) events, notification of the completion of a [batch operation](https://www.shipengine.com/docs/labels/bulk/), or new [salses orders](https://www.shipengine.com/docs/orders/).\n", + "externalDocs": { + "description": "Learn how to setup webhooks and start listening to ShipEngine events.", + "url": "https://www.shipengine.com/docs/tracking/webhooks/" + }, + "name": "webhooks", + "x-displayName": "Webhooks" + } + ] +} diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..086fbda --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +# a2a-pack is installed by the platform base image. +deepagents>=0.5.0 +langchain>=0.3 +langchain-openai>=0.2 +langchain-core>=0.3 +langgraph>=0.6 +httpx>=0.27 diff --git a/skills/account/SKILL.md b/skills/account/SKILL.md new file mode 100644 index 0000000..8811009 --- /dev/null +++ b/skills/account/SKILL.md @@ -0,0 +1,64 @@ +--- +name: account-routes +description: Handle 6 OpenAPI operation(s) under /v1/account/settings for the account route group. +--- + +# account API Routes + +Handle 6 OpenAPI operation(s) under /v1/account/settings for the account route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_account_settings + +- Operation ID: `list_account_settings` +- Route: `GET /v1/account/settings` +- Mode: READ +- Summary: List Account Settings + +### list_account_images + +- Operation ID: `list_account_images` +- Route: `GET /v1/account/settings/images` +- Mode: READ +- Summary: List Account Images + +### create_account_image + +- Operation ID: `create_account_image` +- Route: `POST /v1/account/settings/images` +- Mode: WRITE +- Summary: Create an Account Image +- Body: JSON request body accepted. + +### get_account_settings_images_by_id + +- Operation ID: `get_account_settings_images_by_id` +- Route: `GET /v1/account/settings/images/{label_image_id}` +- Mode: READ +- Summary: Get Account Image By ID +- Parameters: + - `label_image_id` in `path` required + +### update_account_settings_images_by_id + +- Operation ID: `update_account_settings_images_by_id` +- Route: `PUT /v1/account/settings/images/{label_image_id}` +- Mode: WRITE +- Summary: Update Account Image By ID +- Parameters: + - `label_image_id` in `path` required +- Body: JSON request body accepted. + +### delete_account_image_by_id + +- Operation ID: `delete_account_image_by_id` +- Route: `DELETE /v1/account/settings/images/{label_image_id}` +- Mode: WRITE +- Summary: Delete Account Image By Id +- Parameters: + - `label_image_id` in `path` required diff --git a/skills/addresses/SKILL.md b/skills/addresses/SKILL.md new file mode 100644 index 0000000..b42bfec --- /dev/null +++ b/skills/addresses/SKILL.md @@ -0,0 +1,30 @@ +--- +name: addresses-routes +description: Handle 2 OpenAPI operation(s) under /v1/addresses for the addresses route group. +--- + +# addresses API Routes + +Handle 2 OpenAPI operation(s) under /v1/addresses for the addresses route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### parse_address + +- Operation ID: `parse_address` +- Route: `PUT /v1/addresses/recognize` +- Mode: WRITE +- Summary: Parse an address +- Body: JSON request body accepted. + +### validate_address + +- Operation ID: `validate_address` +- Route: `POST /v1/addresses/validate` +- Mode: WRITE +- Summary: Validate An Address +- Body: JSON request body accepted. diff --git a/skills/batches/SKILL.md b/skills/batches/SKILL.md new file mode 100644 index 0000000..395d454 --- /dev/null +++ b/skills/batches/SKILL.md @@ -0,0 +1,117 @@ +--- +name: batches-routes +description: Handle 10 OpenAPI operation(s) under /v1/batches for the batches route group. +--- + +# batches API Routes + +Handle 10 OpenAPI operation(s) under /v1/batches for the batches route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_batches + +- Operation ID: `list_batches` +- Route: `GET /v1/batches` +- Mode: READ +- Summary: List Batches +- Parameters: + - `status` in `query` + - `page` in `query` + - `page_size` in `query` + - `sort_dir` in `query` + - `batch_number` in `query` + - `created_at_start` in `query` + - `created_at_end` in `query` + - `processed_at_start` in `query` + - `processed_at_end` in `query` + - `sort_by` in `query` + +### create_batch + +- Operation ID: `create_batch` +- Route: `POST /v1/batches` +- Mode: WRITE +- Summary: Create A Batch +- Body: JSON request body accepted. + +### get_batch_by_external_id + +- Operation ID: `get_batch_by_external_id` +- Route: `GET /v1/batches/external_batch_id/{external_batch_id}` +- Mode: READ +- Summary: Get Batch By External ID +- Parameters: + - `external_batch_id` in `path` required + +### delete_batch + +- Operation ID: `delete_batch` +- Route: `DELETE /v1/batches/{batch_id}` +- Mode: WRITE +- Summary: Delete Batch By Id +- Parameters: + - `batch_id` in `path` required + +### get_batch_by_id + +- Operation ID: `get_batch_by_id` +- Route: `GET /v1/batches/{batch_id}` +- Mode: READ +- Summary: Get Batch By ID +- Parameters: + - `batch_id` in `path` required + +### update_batch + +- Operation ID: `update_batch` +- Route: `PUT /v1/batches/{batch_id}` +- Mode: WRITE +- Summary: Update Batch By Id +- Parameters: + - `batch_id` in `path` required + +### add_to_batch + +- Operation ID: `add_to_batch` +- Route: `POST /v1/batches/{batch_id}/add` +- Mode: WRITE +- Summary: Add to a Batch +- Parameters: + - `batch_id` in `path` required +- Body: JSON request body accepted. + +### list_batch_errors + +- Operation ID: `list_batch_errors` +- Route: `GET /v1/batches/{batch_id}/errors` +- Mode: READ +- Summary: Get Batch Errors +- Parameters: + - `batch_id` in `path` required + - `page` in `query` + - `pagesize` in `query` + +### process_batch + +- Operation ID: `process_batch` +- Route: `POST /v1/batches/{batch_id}/process/labels` +- Mode: WRITE +- Summary: Process Batch ID Labels +- Parameters: + - `batch_id` in `path` required +- Body: JSON request body accepted. + +### remove_from_batch + +- Operation ID: `remove_from_batch` +- Route: `POST /v1/batches/{batch_id}/remove` +- Mode: WRITE +- Summary: Remove From Batch +- Parameters: + - `batch_id` in `path` required +- Body: JSON request body accepted. diff --git a/skills/carriers/SKILL.md b/skills/carriers/SKILL.md new file mode 100644 index 0000000..3acc328 --- /dev/null +++ b/skills/carriers/SKILL.md @@ -0,0 +1,76 @@ +--- +name: carriers-routes +description: Handle 7 OpenAPI operation(s) under /v1/carriers for the carriers route group. +--- + +# carriers API Routes + +Handle 7 OpenAPI operation(s) under /v1/carriers for the carriers route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_carriers + +- Operation ID: `list_carriers` +- Route: `GET /v1/carriers` +- Mode: READ +- Summary: List Carriers + +### get_carrier_by_id + +- Operation ID: `get_carrier_by_id` +- Route: `GET /v1/carriers/{carrier_id}` +- Mode: READ +- Summary: Get Carrier By ID +- Parameters: + - `carrier_id` in `path` required + +### disconnect_carrier_by_id + +- Operation ID: `disconnect_carrier_by_id` +- Route: `DELETE /v1/carriers/{carrier_id}` +- Mode: WRITE +- Summary: Disconnect Carrier by ID +- Parameters: + - `carrier_id` in `path` required + +### add_funds_to_carrier + +- Operation ID: `add_funds_to_carrier` +- Route: `PUT /v1/carriers/{carrier_id}/add_funds` +- Mode: WRITE +- Summary: Add Funds To Carrier +- Parameters: + - `carrier_id` in `path` required +- Body: JSON request body accepted. + +### get_carrier_options + +- Operation ID: `get_carrier_options` +- Route: `GET /v1/carriers/{carrier_id}/options` +- Mode: READ +- Summary: Get Carrier Options +- Parameters: + - `carrier_id` in `path` required + +### list_carrier_package_types + +- Operation ID: `list_carrier_package_types` +- Route: `GET /v1/carriers/{carrier_id}/packages` +- Mode: READ +- Summary: List Carrier Package Types +- Parameters: + - `carrier_id` in `path` required + +### list_carrier_services + +- Operation ID: `list_carrier_services` +- Route: `GET /v1/carriers/{carrier_id}/services` +- Mode: READ +- Summary: List Carrier Services +- Parameters: + - `carrier_id` in `path` required diff --git a/skills/connections/SKILL.md b/skills/connections/SKILL.md new file mode 100644 index 0000000..356f792 --- /dev/null +++ b/skills/connections/SKILL.md @@ -0,0 +1,70 @@ +--- +name: connections-routes +description: Handle 6 OpenAPI operation(s) under /v1/connections for the connections route group. +--- + +# connections API Routes + +Handle 6 OpenAPI operation(s) under /v1/connections for the connections route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### connect_carrier + +- Operation ID: `connect_carrier` +- Route: `POST /v1/connections/carriers/{carrier_name}` +- Mode: WRITE +- Summary: Connect a carrier account +- Parameters: + - `carrier_name` in `path` required +- Body: JSON request body accepted. + +### disconnect_carrier + +- Operation ID: `disconnect_carrier` +- Route: `DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}` +- Mode: WRITE +- Summary: Disconnect a carrier +- Parameters: + - `carrier_name` in `path` required + - `carrier_id` in `path` required + +### get_carrier_settings + +- Operation ID: `get_carrier_settings` +- Route: `GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings` +- Mode: READ +- Summary: Get carrier settings +- Parameters: + - `carrier_name` in `path` required + - `carrier_id` in `path` required + +### update_carrier_settings + +- Operation ID: `update_carrier_settings` +- Route: `PUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settings` +- Mode: WRITE +- Summary: Update carrier settings +- Parameters: + - `carrier_name` in `path` required + - `carrier_id` in `path` required +- Body: JSON request body accepted. + +### disconnect_insurer + +- Operation ID: `disconnect_insurer` +- Route: `DELETE /v1/connections/insurance/shipsurance` +- Mode: WRITE +- Summary: Disconnect a Shipsurance Account + +### connect_insurer + +- Operation ID: `connect_insurer` +- Route: `POST /v1/connections/insurance/shipsurance` +- Mode: WRITE +- Summary: Connect a Shipsurance Account +- Body: JSON request body accepted. diff --git a/skills/documents/SKILL.md b/skills/documents/SKILL.md new file mode 100644 index 0000000..da27c2a --- /dev/null +++ b/skills/documents/SKILL.md @@ -0,0 +1,22 @@ +--- +name: documents-routes +description: Handle 1 OpenAPI operation(s) under /v1/documents/combined_labels for the documents route group. +--- + +# documents API Routes + +Handle 1 OpenAPI operation(s) under /v1/documents/combined_labels for the documents route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### create_combined_label_document + +- Operation ID: `create_combined_label_document` +- Route: `POST /v1/documents/combined_labels` +- Mode: WRITE +- Summary: Created Combined Label Document +- Body: JSON request body accepted. diff --git a/skills/downloads/SKILL.md b/skills/downloads/SKILL.md new file mode 100644 index 0000000..0f580b3 --- /dev/null +++ b/skills/downloads/SKILL.md @@ -0,0 +1,27 @@ +--- +name: downloads-routes +description: Handle 1 OpenAPI operation(s) under /v1/downloads/{dir}/{subdir}/{filename} for the downloads route group. +--- + +# downloads API Routes + +Handle 1 OpenAPI operation(s) under /v1/downloads/{dir}/{subdir}/{filename} for the downloads route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### download_file + +- Operation ID: `download_file` +- Route: `GET /v1/downloads/{dir}/{subdir}/{filename}` +- Mode: READ +- Summary: Download File +- Parameters: + - `subdir` in `path` required + - `filename` in `path` required + - `dir` in `path` required + - `download` in `query` + - `rotation` in `query` diff --git a/skills/environment/SKILL.md b/skills/environment/SKILL.md new file mode 100644 index 0000000..067f9a3 --- /dev/null +++ b/skills/environment/SKILL.md @@ -0,0 +1,57 @@ +--- +name: environment-routes +description: Handle 5 OpenAPI operation(s) under /v1/environment/webhooks for the environment route group. +--- + +# environment API Routes + +Handle 5 OpenAPI operation(s) under /v1/environment/webhooks for the environment route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_webhooks + +- Operation ID: `list_webhooks` +- Route: `GET /v1/environment/webhooks` +- Mode: READ +- Summary: List Webhooks + +### create_webhook + +- Operation ID: `create_webhook` +- Route: `POST /v1/environment/webhooks` +- Mode: WRITE +- Summary: Create a Webhook +- Body: JSON request body accepted. + +### get_webhook_by_id + +- Operation ID: `get_webhook_by_id` +- Route: `GET /v1/environment/webhooks/{webhook_id}` +- Mode: READ +- Summary: Get Webhook By ID +- Parameters: + - `webhook_id` in `path` required + +### update_webhook + +- Operation ID: `update_webhook` +- Route: `PUT /v1/environment/webhooks/{webhook_id}` +- Mode: WRITE +- Summary: Update a Webhook +- Parameters: + - `webhook_id` in `path` required +- Body: JSON request body accepted. + +### delete_webhook + +- Operation ID: `delete_webhook` +- Route: `DELETE /v1/environment/webhooks/{webhook_id}` +- Mode: WRITE +- Summary: Delete Webhook By ID +- Parameters: + - `webhook_id` in `path` required diff --git a/skills/insurance/SKILL.md b/skills/insurance/SKILL.md new file mode 100644 index 0000000..49eb59e --- /dev/null +++ b/skills/insurance/SKILL.md @@ -0,0 +1,29 @@ +--- +name: insurance-routes +description: Handle 2 OpenAPI operation(s) under /v1/insurance/shipsurance for the insurance route group. +--- + +# insurance API Routes + +Handle 2 OpenAPI operation(s) under /v1/insurance/shipsurance for the insurance route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### add_funds_to_insurance + +- Operation ID: `add_funds_to_insurance` +- Route: `PATCH /v1/insurance/shipsurance/add_funds` +- Mode: WRITE +- Summary: Add Funds To Insurance +- Body: JSON request body accepted. + +### get_insurance_balance + +- Operation ID: `get_insurance_balance` +- Route: `GET /v1/insurance/shipsurance/balance` +- Mode: READ +- Summary: Get Insurance Funds Balance diff --git a/skills/labels/SKILL.md b/skills/labels/SKILL.md new file mode 100644 index 0000000..f65c833 --- /dev/null +++ b/skills/labels/SKILL.md @@ -0,0 +1,132 @@ +--- +name: labels-routes +description: Handle 11 OpenAPI operation(s) under /v1/labels for the labels route group. +--- + +# labels API Routes + +Handle 11 OpenAPI operation(s) under /v1/labels for the labels route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_labels + +- Operation ID: `list_labels` +- Route: `GET /v1/labels` +- Mode: READ +- Summary: List labels +- Parameters: + - `label_status` in `query` + - `service_code` in `query` + - `carrier_id` in `query` + - `tracking_number` in `query` + - `batch_id` in `query` + - `rate_id` in `query` + - `shipment_id` in `query` + - `warehouse_id` in `query` + - `created_at_start` in `query` + - `created_at_end` in `query` + - `refund_status` in `query` + - `page` in `query` + - `page_size` in `query` + - `sort_dir` in `query` + - `sort_by` in `query` + +### create_label + +- Operation ID: `create_label` +- Route: `POST /v1/labels` +- Mode: WRITE +- Summary: Purchase Label +- Body: JSON request body accepted. + +### get_label_by_external_shipment_id + +- Operation ID: `get_label_by_external_shipment_id` +- Route: `GET /v1/labels/external_shipment_id/{external_shipment_id}` +- Mode: READ +- Summary: Get Label By External Shipment ID +- Parameters: + - `external_shipment_id` in `path` required + - `label_download_type` in `query` + +### create_label_from_rate + +- Operation ID: `create_label_from_rate` +- Route: `POST /v1/labels/rates/{rate_id}` +- Mode: WRITE +- Summary: Purchase Label with Rate ID +- Parameters: + - `rate_id` in `path` required +- Body: JSON request body accepted. + +### create_label_from_rate_shopper + +- Operation ID: `create_label_from_rate_shopper` +- Route: `POST /v1/labels/rate_shopper_id/{rate_shopper_id}` +- Mode: WRITE +- Summary: Purchase Label from Rate Shopper +- Parameters: + - `rate_shopper_id` in `path` required +- Body: JSON request body accepted. + +### create_label_from_shipment + +- Operation ID: `create_label_from_shipment` +- Route: `POST /v1/labels/shipment/{shipment_id}` +- Mode: WRITE +- Summary: Purchase Label with Shipment ID +- Parameters: + - `shipment_id` in `path` required +- Body: JSON request body accepted. + +### get_label_by_id + +- Operation ID: `get_label_by_id` +- Route: `GET /v1/labels/{label_id}` +- Mode: READ +- Summary: Get Label By ID +- Parameters: + - `label_id` in `path` required + - `label_download_type` in `query` + +### create_return_label + +- Operation ID: `create_return_label` +- Route: `POST /v1/labels/{label_id}/return` +- Mode: WRITE +- Summary: Create a return label +- Parameters: + - `label_id` in `path` required +- Body: JSON request body accepted. + +### get_tracking_log_from_label + +- Operation ID: `get_tracking_log_from_label` +- Route: `GET /v1/labels/{label_id}/track` +- Mode: READ +- Summary: Get Label Tracking Information +- Parameters: + - `label_id` in `path` required + +### void_label + +- Operation ID: `void_label` +- Route: `PUT /v1/labels/{label_id}/void` +- Mode: WRITE +- Summary: Void a Label By ID +- Parameters: + - `label_id` in `path` required + +### cancel_label_refund + +- Operation ID: `cancel_label_refund` +- Route: `POST /v1/labels/{label_id}/cancel_refund` +- Mode: WRITE +- Summary: Cancel a label refund request +- Parameters: + - `label_id` in `path` required diff --git a/skills/manifests/SKILL.md b/skills/manifests/SKILL.md new file mode 100644 index 0000000..f7a4de8 --- /dev/null +++ b/skills/manifests/SKILL.md @@ -0,0 +1,57 @@ +--- +name: manifests-routes +description: Handle 4 OpenAPI operation(s) under /v1/manifests for the manifests route group. +--- + +# manifests API Routes + +Handle 4 OpenAPI operation(s) under /v1/manifests for the manifests route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_manifests + +- Operation ID: `list_manifests` +- Route: `GET /v1/manifests` +- Mode: READ +- Summary: List Manifests +- Parameters: + - `warehouse_id` in `query` + - `ship_date_start` in `query` + - `ship_date_end` in `query` + - `created_at_start` in `query` + - `created_at_end` in `query` + - `carrier_id` in `query` + - `page` in `query` + - `page_size` in `query` + - `label_ids` in `query` + +### create_manifest + +- Operation ID: `create_manifest` +- Route: `POST /v1/manifests` +- Mode: WRITE +- Summary: Create Manifest +- Body: JSON request body accepted. + +### get_manifest_by_id + +- Operation ID: `get_manifest_by_id` +- Route: `GET /v1/manifests/{manifest_id}` +- Mode: READ +- Summary: Get Manifest By Id +- Parameters: + - `manifest_id` in `path` required + +### get_manifest_request_by_id + +- Operation ID: `get_manifest_request_by_id` +- Route: `GET /v1/manifests/requests/{manifest_request_id}` +- Mode: READ +- Summary: Get Manifest Request By Id +- Parameters: + - `manifest_request_id` in `path` required diff --git a/skills/packages/SKILL.md b/skills/packages/SKILL.md new file mode 100644 index 0000000..5ddcde1 --- /dev/null +++ b/skills/packages/SKILL.md @@ -0,0 +1,57 @@ +--- +name: packages-routes +description: Handle 5 OpenAPI operation(s) under /v1/packages for the packages route group. +--- + +# packages API Routes + +Handle 5 OpenAPI operation(s) under /v1/packages for the packages route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_package_types + +- Operation ID: `list_package_types` +- Route: `GET /v1/packages` +- Mode: READ +- Summary: List Custom Package Types + +### create_package_type + +- Operation ID: `create_package_type` +- Route: `POST /v1/packages` +- Mode: WRITE +- Summary: Create Custom Package Type +- Body: JSON request body accepted. + +### get_package_type_by_id + +- Operation ID: `get_package_type_by_id` +- Route: `GET /v1/packages/{package_id}` +- Mode: READ +- Summary: Get Custom Package Type By ID +- Parameters: + - `package_id` in `path` required + +### update_package_type + +- Operation ID: `update_package_type` +- Route: `PUT /v1/packages/{package_id}` +- Mode: WRITE +- Summary: Update Custom Package Type By ID +- Parameters: + - `package_id` in `path` required +- Body: JSON request body accepted. + +### delete_package_type + +- Operation ID: `delete_package_type` +- Route: `DELETE /v1/packages/{package_id}` +- Mode: WRITE +- Summary: Delete A Custom Package By ID +- Parameters: + - `package_id` in `path` required diff --git a/skills/pickups/SKILL.md b/skills/pickups/SKILL.md new file mode 100644 index 0000000..f14dd43 --- /dev/null +++ b/skills/pickups/SKILL.md @@ -0,0 +1,54 @@ +--- +name: pickups-routes +description: Handle 4 OpenAPI operation(s) under /v1/pickups for the pickups route group. +--- + +# pickups API Routes + +Handle 4 OpenAPI operation(s) under /v1/pickups for the pickups route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_scheduled_pickups + +- Operation ID: `list_scheduled_pickups` +- Route: `GET /v1/pickups` +- Mode: READ +- Summary: List Scheduled Pickups +- Parameters: + - `carrier_id` in `query` + - `warehouse_id` in `query` + - `created_at_start` in `query` + - `created_at_end` in `query` + - `page` in `query` + - `page_size` in `query` + +### schedule_pickup + +- Operation ID: `schedule_pickup` +- Route: `POST /v1/pickups` +- Mode: WRITE +- Summary: Schedule a Pickup +- Body: JSON request body accepted. + +### get_pickup_by_id + +- Operation ID: `get_pickup_by_id` +- Route: `GET /v1/pickups/{pickup_id}` +- Mode: READ +- Summary: Get Pickup By ID +- Parameters: + - `pickup_id` in `path` required + +### delete_scheduled_pickup + +- Operation ID: `delete_scheduled_pickup` +- Route: `DELETE /v1/pickups/{pickup_id}` +- Mode: WRITE +- Summary: Delete a Scheduled Pickup +- Parameters: + - `pickup_id` in `path` required diff --git a/skills/rates/SKILL.md b/skills/rates/SKILL.md new file mode 100644 index 0000000..d716f29 --- /dev/null +++ b/skills/rates/SKILL.md @@ -0,0 +1,47 @@ +--- +name: rates-routes +description: Handle 4 OpenAPI operation(s) under /v1/rates for the rates route group. +--- + +# rates API Routes + +Handle 4 OpenAPI operation(s) under /v1/rates for the rates route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### calculate_rates + +- Operation ID: `calculate_rates` +- Route: `POST /v1/rates` +- Mode: WRITE +- Summary: Get Shipping Rates +- Body: JSON request body accepted. + +### compare_bulk_rates + +- Operation ID: `compare_bulk_rates` +- Route: `POST /v1/rates/bulk` +- Mode: WRITE +- Summary: Get Bulk Rates +- Body: JSON request body accepted. + +### estimate_rates + +- Operation ID: `estimate_rates` +- Route: `POST /v1/rates/estimate` +- Mode: WRITE +- Summary: Estimate Rates +- Body: JSON request body accepted. + +### get_rate_by_id + +- Operation ID: `get_rate_by_id` +- Route: `GET /v1/rates/{rate_id}` +- Mode: READ +- Summary: Get Rate By ID +- Parameters: + - `rate_id` in `path` required diff --git a/skills/service-points/SKILL.md b/skills/service-points/SKILL.md new file mode 100644 index 0000000..6da5211 --- /dev/null +++ b/skills/service-points/SKILL.md @@ -0,0 +1,33 @@ +--- +name: service-points-routes +description: Handle 2 OpenAPI operation(s) under /v1/service_points for the service points route group. +--- + +# service points API Routes + +Handle 2 OpenAPI operation(s) under /v1/service_points for the service points route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### service_points_list + +- Operation ID: `service_points_list` +- Route: `POST /v1/service_points/list` +- Mode: WRITE +- Summary: List Service Points +- Body: JSON request body accepted. + +### service_points_get_by_id + +- Operation ID: `service_points_get_by_id` +- Route: `GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}` +- Mode: READ +- Summary: Get Service Point By ID +- Parameters: + - `carrier_code` in `path` required + - `country_code` in `path` required + - `service_point_id` in `path` required diff --git a/skills/shipments/SKILL.md b/skills/shipments/SKILL.md new file mode 100644 index 0000000..7d557da --- /dev/null +++ b/skills/shipments/SKILL.md @@ -0,0 +1,134 @@ +--- +name: shipments-routes +description: Handle 12 OpenAPI operation(s) under /v1/shipments for the shipments route group. +--- + +# shipments API Routes + +Handle 12 OpenAPI operation(s) under /v1/shipments for the shipments route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_shipments + +- Operation ID: `list_shipments` +- Route: `GET /v1/shipments` +- Mode: READ +- Summary: List Shipments +- Parameters: + - `shipment_status` in `query` + - `batch_id` in `query` + - `tag` in `query` + - `created_at_start` in `query` + - `created_at_end` in `query` + - `modified_at_start` in `query` + - `modified_at_end` in `query` + - `page` in `query` + - `page_size` in `query` + - `sales_order_id` in `query` + - `sort_dir` in `query` + - `sort_by` in `query` + +### create_shipments + +- Operation ID: `create_shipments` +- Route: `POST /v1/shipments` +- Mode: WRITE +- Summary: Create Shipments +- Body: JSON request body accepted. + +### get_shipment_by_external_id + +- Operation ID: `get_shipment_by_external_id` +- Route: `GET /v1/shipments/external_shipment_id/{external_shipment_id}` +- Mode: READ +- Summary: Get Shipment By External ID +- Parameters: + - `external_shipment_id` in `path` required + +### parse_shipment + +- Operation ID: `parse_shipment` +- Route: `PUT /v1/shipments/recognize` +- Mode: WRITE +- Summary: Parse shipping info +- Body: JSON request body accepted. + +### get_shipment_by_id + +- Operation ID: `get_shipment_by_id` +- Route: `GET /v1/shipments/{shipment_id}` +- Mode: READ +- Summary: Get Shipment By ID +- Parameters: + - `shipment_id` in `path` required + +### update_shipment + +- Operation ID: `update_shipment` +- Route: `PUT /v1/shipments/{shipment_id}` +- Mode: WRITE +- Summary: Update Shipment By ID +- Parameters: + - `shipment_id` in `path` required +- Body: JSON request body accepted. + +### cancel_shipments + +- Operation ID: `cancel_shipments` +- Route: `PUT /v1/shipments/{shipment_id}/cancel` +- Mode: WRITE +- Summary: Cancel a Shipment +- Parameters: + - `shipment_id` in `path` required + +### list_shipment_rates + +- Operation ID: `list_shipment_rates` +- Route: `GET /v1/shipments/{shipment_id}/rates` +- Mode: READ +- Summary: Get Shipment Rates +- Parameters: + - `shipment_id` in `path` required + - `created_at_start` in `query` + +### shipments_update_tags + +- Operation ID: `shipments_update_tags` +- Route: `PUT /v1/shipments/tags` +- Mode: WRITE +- Summary: Update Shipments Tags +- Body: JSON request body accepted. + +### shipments_list_tags + +- Operation ID: `shipments_list_tags` +- Route: `GET /v1/shipments/{shipment_id}/tags` +- Mode: READ +- Summary: Get Shipment Tags +- Parameters: + - `shipment_id` in `path` required + +### tag_shipment + +- Operation ID: `tag_shipment` +- Route: `POST /v1/shipments/{shipment_id}/tags/{tag_name}` +- Mode: WRITE +- Summary: Add Tag to Shipment +- Parameters: + - `shipment_id` in `path` required + - `tag_name` in `path` required + +### untag_shipment + +- Operation ID: `untag_shipment` +- Route: `DELETE /v1/shipments/{shipment_id}/tags/{tag_name}` +- Mode: WRITE +- Summary: Remove Tag from Shipment +- Parameters: + - `shipment_id` in `path` required + - `tag_name` in `path` required diff --git a/skills/tags/SKILL.md b/skills/tags/SKILL.md new file mode 100644 index 0000000..5f58454 --- /dev/null +++ b/skills/tags/SKILL.md @@ -0,0 +1,57 @@ +--- +name: tags-routes +description: Handle 5 OpenAPI operation(s) under /v1/tags for the tags route group. +--- + +# tags API Routes + +Handle 5 OpenAPI operation(s) under /v1/tags for the tags route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_tags + +- Operation ID: `list_tags` +- Route: `GET /v1/tags` +- Mode: READ +- Summary: Get Tags + +### create_tag + +- Operation ID: `create_tag` +- Route: `POST /v1/tags` +- Mode: WRITE +- Summary: Create a New Tag +- Body: JSON request body accepted. + +### create_tag_2 + +- Operation ID: `create_tag_2` +- Route: `POST /v1/tags/{tag_name}` +- Mode: WRITE +- Summary: Create a New Tag +- Parameters: + - `tag_name` in `path` required + +### delete_tag + +- Operation ID: `delete_tag` +- Route: `DELETE /v1/tags/{tag_name}` +- Mode: WRITE +- Summary: Delete Tag +- Parameters: + - `tag_name` in `path` required + +### rename_tag + +- Operation ID: `rename_tag` +- Route: `PUT /v1/tags/{tag_name}/{new_tag_name}` +- Mode: WRITE +- Summary: Update Tag Name +- Parameters: + - `tag_name` in `path` required + - `new_tag_name` in `path` required diff --git a/skills/tokens/SKILL.md b/skills/tokens/SKILL.md new file mode 100644 index 0000000..e6c9e37 --- /dev/null +++ b/skills/tokens/SKILL.md @@ -0,0 +1,23 @@ +--- +name: tokens-routes +description: Handle 1 OpenAPI operation(s) under /v1/tokens/ephemeral for the tokens route group. +--- + +# tokens API Routes + +Handle 1 OpenAPI operation(s) under /v1/tokens/ephemeral for the tokens route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### tokens_get_ephemeral_token + +- Operation ID: `tokens_get_ephemeral_token` +- Route: `POST /v1/tokens/ephemeral` +- Mode: WRITE +- Summary: Get Ephemeral Token +- Parameters: + - `redirect` in `query` diff --git a/skills/tracking/SKILL.md b/skills/tracking/SKILL.md new file mode 100644 index 0000000..4e9b401 --- /dev/null +++ b/skills/tracking/SKILL.md @@ -0,0 +1,47 @@ +--- +name: tracking-routes +description: Handle 3 OpenAPI operation(s) under /v1/tracking for the tracking route group. +--- + +# tracking API Routes + +Handle 3 OpenAPI operation(s) under /v1/tracking for the tracking route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### get_tracking_log + +- Operation ID: `get_tracking_log` +- Route: `GET /v1/tracking` +- Mode: READ +- Summary: Get Tracking Information +- Parameters: + - `carrier_code` in `query` + - `tracking_number` in `query` + - `carrier_id` in `query` + +### start_tracking + +- Operation ID: `start_tracking` +- Route: `POST /v1/tracking/start` +- Mode: WRITE +- Summary: Start Tracking a Package +- Parameters: + - `carrier_code` in `query` + - `tracking_number` in `query` + - `carrier_id` in `query` + +### stop_tracking + +- Operation ID: `stop_tracking` +- Route: `POST /v1/tracking/stop` +- Mode: WRITE +- Summary: Stop Tracking a Package +- Parameters: + - `carrier_code` in `query` + - `tracking_number` in `query` + - `carrier_id` in `query` diff --git a/skills/warehouses/SKILL.md b/skills/warehouses/SKILL.md new file mode 100644 index 0000000..dd84fc0 --- /dev/null +++ b/skills/warehouses/SKILL.md @@ -0,0 +1,67 @@ +--- +name: warehouses-routes +description: Handle 6 OpenAPI operation(s) under /v1/warehouses for the warehouses route group. +--- + +# warehouses API Routes + +Handle 6 OpenAPI operation(s) under /v1/warehouses for the warehouses route group. + +Use the generated operation tools to make real API calls. Do not invent API responses. +If a tool reports missing setup, return the exact setup field name to the caller. +For write, update, or delete operations, state the intended action before calling the tool. + +## Operations + +### list_warehouses + +- Operation ID: `list_warehouses` +- Route: `GET /v1/warehouses` +- Mode: READ +- Summary: List Warehouses + +### create_warehouse + +- Operation ID: `create_warehouse` +- Route: `POST /v1/warehouses` +- Mode: WRITE +- Summary: Create Warehouse +- Body: JSON request body accepted. + +### get_warehouse_by_id + +- Operation ID: `get_warehouse_by_id` +- Route: `GET /v1/warehouses/{warehouse_id}` +- Mode: READ +- Summary: Get Warehouse By Id +- Parameters: + - `warehouse_id` in `path` required + +### update_warehouse + +- Operation ID: `update_warehouse` +- Route: `PUT /v1/warehouses/{warehouse_id}` +- Mode: WRITE +- Summary: Update Warehouse By Id +- Parameters: + - `warehouse_id` in `path` required +- Body: JSON request body accepted. + +### delete_warehouse + +- Operation ID: `delete_warehouse` +- Route: `DELETE /v1/warehouses/{warehouse_id}` +- Mode: WRITE +- Summary: Delete Warehouse By ID +- Parameters: + - `warehouse_id` in `path` required + +### update_warehouse_settings + +- Operation ID: `update_warehouse_settings` +- Route: `PUT /v1/warehouses/{warehouse_id}/settings` +- Mode: WRITE +- Summary: Update Warehouse Settings +- Parameters: + - `warehouse_id` in `path` required +- Body: JSON request body accepted.